README.md

Outscale CLI (osc-cli)

Warning

osc-cli is deprecated and is no longer actively maintained.

We recommend using octl instead. octl is our latest CLI project and is actively maintained.

Quick start

macOS (Homebrew)

brew install osc-cli

Linux (AppImage)

# get the latest release from GitHub
chmod a+x osc-cli-x86_64.AppImage
./osc-cli-x86_64.AppImage
# (optional) sudo mv osc-cli-x86_64.AppImage /usr/local/bin/osc-cli

Python package

pip3 install osc-sdk

Windows See docs/install/windows.md.

Minimal configuration

Create ~/.osc/config.json:

{
  "default": {
    "access_key": "MYACCESSKEY",
    "secret_key": "MYSECRETKEY",
    "region": "eu-west-2"
  }
}

Usage

osc-cli SERVICE CALL [PROFILE] [CALL-PARAMETERS]
# example:
osc-cli api ReadVms

Documentation

• Installation guides (macOS, Linux/AppImage, Windows, pip, source): docs/install/
• Configuration and profiles: docs/configuration.md
• Usage and argument parsing: docs/usage.md, docs/argument-parsing.md
• Shell completion: docs/completion.md
• Troubleshooting & FAQ: docs/troubleshooting.md

Contributing

See CONTRIBUTING.md.

License

BSD-3-Clause. See LICENSE.