{"id":30033635,"url":"https://github.com/outscale/oks-cli","last_synced_at":"2026-02-18T12:04:53.000Z","repository":{"id":306263322,"uuid":"1003595096","full_name":"outscale/oks-cli","owner":"outscale","description":"OKS-CLI is a command-line interface that allows you to deploy and manage Kubernetes clusters on top of OUTSCALE infrastructure.","archived":false,"fork":false,"pushed_at":"2025-08-01T12:28:09.000Z","size":42,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-01T14:42:17.316Z","etag":null,"topics":["kubernetes","maturity-graduated"],"latest_commit_sha":null,"homepage":"https://docs.outscale.com/en/userguide/Installing-and-Configuring-OKS-CLI.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-17T11:36:19.000Z","updated_at":"2025-07-31T08:45:55.000Z","dependencies_parsed_at":"2025-07-24T17:59:32.385Z","dependency_job_id":"69dfee74-da87-440c-aff7-5e73749b8ee2","html_url":"https://github.com/outscale/oks-cli","commit_stats":null,"previous_names":["outscale/oks-cli"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/outscale/oks-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Foks-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Foks-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Foks-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Foks-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/oks-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Foks-cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269169620,"owners_count":24372062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-06T02:00:09.910Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kubernetes","maturity-graduated"],"created_at":"2025-08-06T22:50:02.005Z","updated_at":"2026-02-18T12:04:52.993Z","avatar_url":"https://github.com/outscale.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OKS-CLI\n\n[![Project Incubating](https://docs.outscale.com/fr/userguide/_images/Project-Incubating-blue.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)\n[![](https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat\u0026theme=default-inverted)](https://discord.gg/HUVtY5gT6s)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Kubernetes\" src=\"https://upload.wikimedia.org/wikipedia/commons/3/39/Kubernetes_logo_without_workmark.svg\" width=\"120px\"\u003e\n\u003c/p\u003e\n\n---\n\n## 🌐 Links\n\n* 📘 [OKS-CLI Documentation](https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html)\n* 📘 [OKS API Reference](https://docs.outscale.com/oks.html)\n* 🐛 [GitHub Issues](https://github.com/outscale/oks-cli/issues)\n\n---\n\n## 📄 Table of Contents\n\n* [Overview](#-overview)\n* [Requirements](#-requirements)\n* [Installation](#-installation)\n\n  * [Standard Installation](#standard-installation)\n  * [User Installation](#user-installation)\n* [Usage](#-usage)\n\n  * [Commands](#commands)\n  * [Examples](#examples)\n* [Development](#-development)\n\n  * [Editable Mode](#editable-mode)\n  * [Project Structure](#project-structure)\n  * [Dependencies](#dependencies)\n* [Contributing](#-contributing)\n* [License](#-license)\n* [Support](#-support)\n\n---\n\n## 🧭 Overview\n\n**OKS-CLI** is a command-line interface that allows you to deploy and manage Kubernetes clusters on top of OUTSCALE infrastructure.\n\n---\n\n## ✅ Requirements\n\n* Python 3.11 or later\n* `pip` (Python package manager)\n* `kubectl` (required for commands that interact with the Kubernetes API)\n\n---\n\n## 📦 Installation\n\n### Standard Installation\n\n```bash\n# Create and activate a virtual environment\npython -m venv venv\nsource venv/bin/activate\n\n# Install the CLI\npip install oks-cli\n\n# Check version of oks-cli\noks-cli version\n```\n\n---\n\n## 🚀 Usage\n\nDisplay all available commands:\n\n```bash\noks-cli fullhelp\n```\n\n### Commands\n\n| Command                              | Description                                                   |\n|--------------------------------------|---------------------------------------------------------------|\n| profile list                         | List existing profiles                                        |\n| profile add                          | Add AK/SK or username/password new profile                    |\n| profile delete                       | Delete a profile by name                                      |\n| profile update                       | Update an existing profile                                    |\n| project list                         | List all projects                                             |\n| project create                       | Create a new project                                          |\n| project get                          | Get default project or the project by name                    |\n| project update                       | Update a project by name                                      |\n| project delete                       | Delete a project by name                                      |\n| project login                        | Set a default project by name                                 |\n| project logout                       | Unset default project                                         |\n| project quotas                       | Get project quotas                                            |\n| project snapshots                    | Get project snapshots                                         |\n| project publicips                    | Get project public ips                                        |\n| cluster list                         | List all clusters                                             |\n| cluster create                       | Create a new cluster                                          |\n| cluster get                          | Get a cluster by name                                         |\n| cluster update                       | Update a cluster by name                                      |\n| cluster upgrade                      | Upgrade a cluster by name                                     |\n| cluster delete                       | Delete a cluster by name                                      |\n| cluster login                        | Set a default cluster                                         |\n| cluster logout                       | Unset default cluster                                         |\n| cluster kubeconfig                   | Fetch the kubeconfig for a cluster                            |\n| cluster kubectl                      | Fetch kubeconfig and run kubectl against it                   |\n| cluster nodepool list                | List nodepools in the specified cluster                       |\n| cluster nodepool create              | Create a new nodepool in the cluster                          |\n| cluster nodepool delete              | Delete a nodepool by name from the cluster                    |\n| cache clear                          | Clear cache                                                   |\n| cache kubeconfigs                    | List cached kubeconfigs                                       |\n| quotas                               | Get quotas                                                    |\n| fullhelp                             | Display detailed help information for all commands            |\n| version                              | Show the current CLI version                                  |\n| install-completion                   | Install shell completion scripts                              |\n\n---\n\n### Examples\n\n```bash\n# List all projects\noks-cli project list\n\n# Dry run project creation\noks-cli project create --project-name my-project --description \"Test project\" --dry-run\n\n# Dry run cluster creation\noks-cli cluster create \\\n  --cluster-name my-cluster \\\n  --project-name my-project \\\n  --description \"My test cluster\" \\\n  --version \"1.32\" \\\n  --dry-run\n\n# Set a default project profile\noks-cli project login --project-name my-project\n```\n\n---\n\n## 🛠 Development\n\n### Editable Mode\n\nInstall the CLI in editable mode with development dependencies\n\n```bash\n# Clone the repository\ngit clone https://github.com/outscale/oks-cli.git\ncd oks-cli\n\n# Create and activate a virtual environment\npython -m venv venv\nsource venv/bin/activate\n\n# CLI in editable mode\npip install -e \".[dev]\"\n```\n\nChanges in the `oks_cli/` directory will be immediately reflected without reinstalling.\n\n### Tests\n\nRun the test suite using `pytest` to ensure code correctness and stability:\n\n```bash\npytest\n```\n\n### Project Structure\n\n```\noks-cli/\n├── oks_cli/              # Source code\n│   ├── cache.py\n│   ├── cluster.py\n│   ├── main.py\n│   ├── netpeering.py\n│   ├── profile.py\n│   ├── project.py\n│   ├── quotas.py\n│   └── utils.py\n├── setup.py              # Packaging configuration\n├── requirements.txt      # Dependencies\n└── README.md             # Project documentation\n```\n\n### Dependencies\n\nDependencies are managed via `setup.py` and `requirements.txt`.\n\nTo reinstall or update:\n\n```bash\npip install -e .\n```\n\n---\n\n## 🤝 Contributing\n\nOKS-CLI is open source software licensed under BSD-3-Clause.\n\nWe welcome contributions! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and instructions.\n\n---\n\n## 📜 License\n\n**BSD-3-Clause**\n© Outscale SAS\n\n---\n\n## 🆘 Support\n\n* [Official Documentation](https://docs.outscale.com/fr/userguide/Installer-et-configurer-OKS-CLI.html)\n* [GitHub Issues](https://github.com/outscale/oks-cli/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Foks-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Foks-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Foks-cli/lists"}