From a9336bef9e3a1f274d149892b9484908c302b85b Mon Sep 17 00:00:00 2001 From: Callum Powell Date: Wed, 14 Jan 2026 10:11:10 +0100 Subject: [PATCH 1/2] docs: rework readme --- README.md | 209 +++++++++++++++++++++++++++----------------- assets/idp-logo.svg | 45 ++++++++++ 2 files changed, 176 insertions(+), 78 deletions(-) create mode 100644 assets/idp-logo.svg diff --git a/README.md b/README.md index cb66c0e..42ed5e8 100644 --- a/README.md +++ b/README.md @@ -1,120 +1,173 @@ -# Developer Platform CLI +

+ indev logo +

indev

+

-`indev` is a command-line interface (CLI) tool designed for managing Intility Developer Platform resources. With `indev`, you can perform a variety of operations such as creating and deleting clusters, deploying and managing applications, and more. It is built with simplicity and ease of use in mind, making Kubernetes operations more accessible. +

+ A command-line interface for managing Intility Developer Platform resources. +

-## Features +

+ GitHub Release +Go Version +

-- Create and delete Kubernetes clusters with ease -- Deploy applications to a Kubernetes cluster -- Delete application resources from a cluster -- Forward ports from Kubernetes deployments -- Generate Kubernetes manifests for deployments, services, Dockerfiles, and network policies +

+Build Status +

-## Getting Started +--- -Before you begin, ensure that you have the following installed: +## Installation -- Docker -- `kubectl` command-line tool -- Go (1.24.2 or higher) +### Homebrew (macOS) -### Installation +```sh +brew install intility/tap/indev +``` -To install `indev`, follow these steps: +### Windows / Linux -1. Clone the repository: +Download the latest release for your platform from the [GitHub Releases](https://github.com/intility/indev/releases) page. Extract the archive and add the binary to your PATH. - ```sh - git clone git@gitlab.intility.com:developer-infrastructure/platform-2.0/indev.git - cd indev - ``` +### From Source -2. Build from source: +Requires Go 1.25 or higher. - ```sh - go build -o indev main.go - ``` +```sh +git clone https://github.com/intility/indev.git +cd indev +go build -o indev ./cmd/indev +``` -3. (Optional) Move the binary to a location in your PATH: +## Usage - ```sh - mv indev /usr/local/bin/indev - ``` +### Authentication -### Usage +Log in to the Intility Developer Platform: -Here are some of the commonly used `indev` commands: +```sh +indev login +``` -- Create a cluster: +Log out: - ```sh - indev cluster create - ``` +```sh +indev logout +``` -- List clusters: +View your account information: - ```sh - indev cluster list - ``` +```sh +indev account show +``` -- Delete a cluster: +### Cluster Management - ```sh - indev cluster delete --name - ``` +Create a new Kubernetes cluster: -- Deploy an application: +```sh +indev cluster create +``` - ```sh - indev app deploy --path - ``` +You can also specify options directly: -- Delete an application: +```sh +indev cluster create --name my-cluster --preset balanced --nodes 4 +``` - ```sh - indev app delete --path - ``` +With autoscaling enabled: -- Forward a port: - ```sh - indev app port-forward --deployment - ``` +```sh +indev cluster create --name my-cluster --preset performance --enable-autoscaling --min-nodes 2 --max-nodes 6 +``` -For a full list of command and options, run `indev --help`. +Available node presets: `minimal`, `balanced`, `performance` -## Telemetry +List your clusters: -`indev` includes a telemetry feature that helps improve the tool by collecting anonymous usage data. -The telemetry system gathers information such as command usage, performance metrics, and error reports. -This data is crucial for identifying common issues, understanding user behavior, and prioritizing new features. +```sh +indev cluster list +``` -### What We Collect +Get details for a specific cluster: -- Command usage: Which commands are run, along with flag usage. -- Performance metrics: Response times for commands and other performance-related metrics. -- Error reports: Unhandled errors or exceptions that occur during the use of the tool. +```sh +indev cluster get --name +``` -### Anonymity and Privacy +Check cluster status: -We are fully committed to ensuring user privacy and anonymity. -The telemetry system only collects non-personally identifiable information. -Additionally, data is stored securely and in compliance with relevant data protection regulations. +```sh +indev cluster status --name +``` -### Opting Out +Log in to a cluster (configure kubectl): -Telemetry is enabled by default to help us improve `indev`. However, respecting user choice is paramount, -and you can opt-out of telemetry at any time. To disable telemetry, set the environment variable -`DO_NOT_TRACK` to `1`. +```sh +indev cluster login --name +``` -## Contributing +Open the cluster in the web console: + +```sh +indev cluster open --name +``` + +Delete a cluster: + +```sh +indev cluster delete --name +``` + +### Team Management + +List teams: + +```sh +indev team list +``` + +Create a new team: + +```sh +indev team create --name +``` + +Add a member to a team: -Contributions are welcome! Feel free to open an issue or submit a pull request. +```sh +indev team member add --team --user +``` -## Acknowledgments +Remove a member from a team: -- The `indev` team and all contributors -- The Go and Kubernetes communities for their tools and libraries +```sh +indev team member remove --team --user +``` -## Contact +### User Management + +List users: + +```sh +indev user list +``` + +### Shell Completions + +Shell completions are installed automatically via Homebrew. For manual installation, run `indev completion --help` for instructions. + +## Telemetry + +`indev` collects anonymous usage data to help improve the tool. This includes command usage, performance metrics, and error reports. No personally identifiable information is collected. + +To opt out, set the environment variable: + +```sh +export DO_NOT_TRACK=1 +``` + +## Contributing -For questions or support, please contact Developer Infrastructure. +This project is not currently accepting external contributions. However, we welcome feedback from the community. If you encounter a bug or have a feature request, please [open an issue](https://github.com/intility/indev/issues). diff --git a/assets/idp-logo.svg b/assets/idp-logo.svg new file mode 100644 index 0000000..7f7ed5d --- /dev/null +++ b/assets/idp-logo.svg @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From ea645ea925af7f25638cd858656d8e3329674571 Mon Sep 17 00:00:00 2001 From: Callum Powell Date: Wed, 14 Jan 2026 10:16:01 +0100 Subject: [PATCH 2/2] docs: add oc requirement section --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 42ed5e8..a3f0589 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,14 @@ cd indev go build -o indev ./cmd/indev ``` +## Prerequisites + +Some commands require additional tools to be installed: + +| Command | Requirement | +|---------|-------------| +| `indev cluster login` | [OpenShift CLI (oc)](https://developers.intility.com/docs/getting-started/first-steps/deploy-first-application/?h=oc#install-openshift-cli) | + ## Usage ### Authentication @@ -102,7 +110,7 @@ Check cluster status: indev cluster status --name ``` -Log in to a cluster (configure kubectl): +Log in to a cluster (requires `oc`): ```sh indev cluster login --name