Command Reference

These commands will help you get started with stable.world

stable.world

Stable.World cli

Environment:

* STABLE_WORLD_URL - the url of the api server

* STABLE_WORLD_EMAIL - your account email

* STABLE_WORLD_TOKEN - token

* DEBUG - To print all debugging information use DEBUG=’*’

stable.world [OPTIONS] COMMAND [ARGS]...

Options

--show-traceback, --dont-show-traceback

Show full traceback on a critical error

--ignore-config, --dont-ignore-config

Don’t read the config file from disk

--version

Show the version and exit.

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

--dir <dir>

The Directory of the bucket you want to setup

Environment variables

STABLE_WORLD_SHOW_TRACEBACK

Provide a default for --show-traceback

Commands

bucket

show a published bucket

bucket:cache:add

Add a cache to the bucket

bucket:cache:remove

Remove a cache from the bucket

bucket:create

Create a new bucket

bucket:destroy

tear down a published bucket

bucket:freeze

Freeze a bucket so it can not be modified

bucket:list

list all buckets you have access to

bucket:objects

Show the objects added to a bucket since a…

bucket:rollback

Show the objects added to a bucket since a…

bucket:unfreeze

Unfreeze a bucket so it can be modified

ci

Set up stable.world in your continuous…

ci:bash

Set up stable.world in your continuous…

ci:circle

Set up stable.world in your continuous…

configure

Create user configuration files for commands

info

Fetch environment and server informations

login

only performs authentication step

logout

expire local token

npm

A wrapper around NodeJS’s npm

pip

A wrapper around Python’s pip

register

only performs authentication step

token

Get your authentication token

whoami

show who you are logged in as

CI Integration

Experimental

stable.world ci:circle

Set up stable.world in your continuous delivery pipline using circleci

stable.world ci:circle [OPTIONS]

Options

--dir <dir>

The Directory of the bucket you want to setup

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

stable.world ci:bash

Set up stable.world in your continuous delivery pipline using bash

stable.world ci:bash [OPTIONS]

Options

--dir <dir>

The Directory of the bucket you want to setup

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Authentication Commands

stable.world register

only performs authentication step

stable.world register [OPTIONS]

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

stable.world login

only performs authentication step

stable.world login [OPTIONS]

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

stable.world logout

expire local token

stable.world logout [OPTIONS]

stable.world token

Get your authentication token

stable.world token [OPTIONS]

Options

--email <email>

Your email address

--password <password>

Your password

-b, --bucket <bucket>

Name of bucket

stable.world whoami

show who you are logged in as

stable.world whoami [OPTIONS]

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Bucket Commands

These commands manipulate stable.world buckets

stable.world bucket:list

list all buckets you have access to

stable.world bucket:list [OPTIONS]

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

stable.world bucket

show a published bucket

stable.world bucket [OPTIONS] NAME

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:cache:add

Add a cache to the bucket

stable.world bucket:cache:add [OPTIONS] NAME

Options

--url <url>

The url endpoint to cache

--type <type>

type of cache

-n, --cache-name <cache_name>

Required Give it a name

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:cache:remove

Remove a cache from the bucket

stable.world bucket:cache:remove [OPTIONS] NAME

Options

-n, --cache-name <cache_name>

name of cache to remove

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:create

Create a new bucket

stable.world bucket:create [OPTIONS] NAME

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

stable.world bucket:destroy

tear down a published bucket

stable.world bucket:destroy [OPTIONS] NAME

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:freeze

Freeze a bucket so it can not be modified

stable.world bucket:freeze [OPTIONS] NAME

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:unfreeze

Unfreeze a bucket so it can be modified

stable.world bucket:unfreeze [OPTIONS] NAME

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:objects

Show the objects added to a bucket since a time

stable.world bucket:objects [OPTIONS] NAME

Options

-w, --since <since>

Show objects after date

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

stable.world bucket:rollback

Show the objects added to a bucket since a time

stable.world bucket:rollback [OPTIONS] NAME

Options

-w, --when <when>

Required Rollback after

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token

Arguments

NAME

Required argument

Environment variables

STABLE_WORLD_BUCKET

Provide a default for NAME

Configuration Commands

These commands can be used in your build script

stable.world configure

Create user configuration files for commands

stable.world configure [OPTIONS] COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...

Options

--dryrun, --no-dryrun

only print output don’t modify config files

-b, --bucket <bucket>

Required Name of bucket

Commands

npm

set npm user configuration files

pip

set pip user configuration files

stable.world configure pip

set pip user configuration files

stable.world configure pip [OPTIONS]

Misc Commands

stable.world info

Fetch environment and server informations

stable.world info [OPTIONS]

Options

--email <email>

Your email address

--password <password>

Your password

--token <token>

An authentication token