- Documentation (this repo): docs/README.md
- OUTSCALE documentation: docs
- Releases: https://github.com/outscale/octl/releases
- Join our community on Discord
- 🌐 Links
- 🧭 Overview
- ✅ Requirements
- ⚙ Installation
- 🛠 Configuration
- 🚀 Quickstart
- 📚 Documentation
- 📜 License
- 🤝 Contributing
octl is a modern CLI for the Outscale APIs, written in Go.
It supports:
- installation via a single static binary,
- direct flags to all request fields (no JSON required),
- autocompletion support for all API calls, flags, and flag values,
- jq-style output filters,
- command chaining,
- syntax highlighting of output,
- auto-update to the latest version.
It manages:
- IaaS resources (nets, vms, ...),
- OOS storage (buckets, objects).
And includes a preliminary support for OKS Kubernetes clusters.
- Access to the OUTSCALE API (with appropriate credentials)
Download the latest binary from the Releases page.
Autocompletion setup is documented here:
Configuration can be provided either via environment variables or a profile file:
Quick example (env vars):
export OSC_ACCESS_KEY="..."
export OSC_SECRET_KEY="..."
export OSC_REGION="eu-west-2"List volumes using the high-level command:
octl iaas volume listCall an API operation directly:
octl iaas api ReadVms --Filters.VmStateNames runningMore examples:
- Start here: docs/README.md
- Installation + completion: docs/installation.md
- Configuration: docs/configuration.md
- Usage overview: docs/usage/overview.md
- Signature verification: docs/signature-verification.md
- Troubleshooting: docs/troubleshooting.md
- Command reference: docs/reference/commands.md
octl is released under the BSD 3-Clause license.
© 2026 Outscale SAS
See LICENSE for full details.
We welcome contributions!
Please read our Contributing Guidelines and Code of Conduct before submitting a pull request.