outscale/osc-cli

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 314 Commits
.github		.github
docs		docs
osc_sdk		osc_sdk
pkg		pkg
tests		tests
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README.md		README.md
bandit.conf		bandit.conf
local_tests.sh		local_tests.sh
pylint_py3.conf		pylint_py3.conf
requirements.txt		requirements.txt
setup.cfg		setup.cfg
setup.py		setup.py

Repository files navigation

Project Graduated Code style: black

Terminal Icon

Outscale CLI (osc-cli)

Official command-line interface for the OUTSCALE API.

Maintenance mode: bug fixes only; no new features. Looking for new features and an improved UX? See oapi-cli .

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