octl

README

OCTL

---

🌐 Links

• Documentation (this repo): docs/README.md
• OUTSCALE documentation: docs
• Releases: https://github.com/outscale/octl/releases
• Join our community on Discord

---

📄 Table of Contents

• 🌐 Links
• 🧭 Overview
• ✅ Requirements
• ⚙ Installation
• 🛠 Configuration
• 🚀 Quickstart
• 📚 Documentation
• 📜 License
• 🤝 Contributing

---

🧭 Overview

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),
• local metadata (when running on a VM).

And includes a preliminary support for OKS Kubernetes clusters.

---

✅ Requirements

• Access to the OUTSCALE API (with appropriate credentials)

---

⚙ Installation

Download the latest binary from the Releases page.

Linux

On an amd64 platform:

curl -L -o octl https://github.com/outscale/octl/releases/latest/download/octl_Linux_x86_64
chmod +x octl
sudo mv octl /usr/local/bin

Autocompletion setup is documented here:

• docs/installation.md

MacOS

Using Homebrew:

brew tap outscale/tap
brew install outscale/tap/octl

Docker

A outscale/octl Docker image is available.

---

🛠 Configuration

Configuration can be provided either via environment variables or a profile file:

• docs/configuration.md

Quick example (env vars):

export OSC_ACCESS_KEY="..."
export OSC_SECRET_KEY="..."
export OSC_REGION="eu-west-2"

🚀 Quickstart

List volumes using the high-level command:

octl iaas volume list

Many shortcuts are also available, the following also works:

octl iaas vol ls

Call an API operation directly:

octl iaas api ReadVms --Filters.VmStateNames running

More examples:

• docs/usage/overview.md
• docs/usage/iaas.md

🐳 Quickstart (Docker)

With environment variables:

docker run --env OSC_ACCESS_KEY=$OSC_ACCESS_KEY --env OSC_SECRET_KEY=$OSC_SECRET_KEY --env OSC_REGION=$OSC_REGION -ti outscale/octl:latest iaas volume list

With a profile file:

docker run --mount type=bind,src=$HOME/.osc,dst=/root/.osc -ti outscale/octl:latest iaas volume list

📚 Documentation

• 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

📜 License

octl is released under the BSD 3-Clause license.

© 2026 Outscale SAS

See LICENSE for full details.

🤝 Contributing

We welcome contributions!

Please read our Contributing Guidelines and Code of Conduct before submitting a pull request.

Documentation

Overview

SPDX-FileCopyrightText: 2026 Outscale SAS <opensource@outscale.com>

SPDX-License-Identifier: BSD-3-Clause