octopaas profile
Switch between the platforms you work with
A profile is one platform: its API address, and optionally an API key. You might have one for production and one for a local cluster.
Which one a command uses is, strongest first: --profile, then OCTOPAAS_PROFILE, then the one profile use made current.
Also: profiles.
octopaas profile add
Add a profile, or change the address or key of one you have.
People should sign in with octopaas auth login --profile <name> afterwards. --with-key stores an API key in the profile instead, for a machine that runs octopaas unattended; it is read from stdin, or asked for without echoing, so it never lands in your shell history.
octopaas profile add <profile> [flags]Examples
octopaas profile add local --url http://localhost:8095 --use
octopaas auth login --profile local
# an unattended machine
echo "$KEY" | octopaas profile add builder --url https://api.octopaas.dev --with-keyFlags
| Flag | What it does | Default |
|---|---|---|
--environment | the environment the profile acts in (default octo) | |
--url | the platform's API address, such as https://api.octopaas.dev | |
--use | make it the current profile too | |
--with-key | store an API key in the profile, read from stdin |
octopaas profile list
List your profiles: which one is current, which one is in effect right now and why, and how each signs in.
octopaas profile listAlso: ls.
Examples
octopaas profile list
OCTOPAAS_PROFILE=local octopaas profile listoctopaas profile rm
Remove a profile and its session.
octopaas profile rm <profile>Also: remove.
Examples
octopaas profile rm stagingoctopaas profile use
Make a profile the one commands use when neither --profile nor OCTOPAAS_PROFILE says otherwise.
octopaas profile use <profile>Examples
octopaas profile use local