Reference

Configuration & Auth


orcher config

Manage CLI configuration. The config file is stored at ~/.orcher/config.yaml and uses kubectl-style contexts for managing multiple environments.

config view

1
orcher config view [--raw]

config get-contexts

1
orcher config get-contexts

Lists all configured contexts.

config use-context

1
orcher config use-context <context>
2
3
# Example
4
orcher config use-context production

config set-context

1
orcher config set-context <context> [OPTIONS]
2
3
# Examples
4
orcher config set-context production --server https://orcher.example.com --namespace prod --timeout 60
5
orcher config set-context local --server http://localhost:8080
OptionDescription
--serverServer URL
--namespaceDefault namespace
--timeoutAPI timeout (seconds)

config set / config unset

1
orcher config set <key> <value>
2
orcher config unset <key>
3
4
# Examples
5
orcher config set namespace production
6
orcher config set output json

config delete-context

1
orcher config delete-context <context>

config test-connection

1
orcher config test-connection [OPTIONS]
2
3
# Examples
4
orcher config test-connection
5
orcher config test-connection --context production
6
orcher config test-connection --server https://orcher.example.com

orcher auth

Manage authentication. Tokens are stored securely in your platform's keychain (macOS Keychain, Linux Secret Service, Windows Credential Manager).

auth login

1
orcher auth login [OPTIONS]
2
3
# Device flow (OAuth)
4
orcher auth login --device --provider github
5
6
# Token-based
7
orcher auth login --token
8
9
# Basic auth
10
orcher auth login --username user@example.com
11
12
# Specify server
13
orcher auth login --server https://orcher.example.com --device
OptionDescription
--serverServer URL to authenticate against
--tokenToken-based authentication (prompts for token)
--deviceOAuth device flow (opens browser)
--providerOAuth provider: github, google, microsoft (requires --device)
-u, --usernameUsername for basic auth (prompts for password)

The ORCHER_TOKEN environment variable takes highest priority over any stored credentials.

auth logout

1
orcher auth logout

Removes stored credentials for the current context.

auth status

1
orcher auth status

Shows current authentication status.


orcher completion

Generate shell completion scripts.

1
orcher completion <shell>
2
3
# Examples
4
orcher completion bash >> ~/.bashrc
5
orcher completion zsh >> ~/.zshrc
6
orcher completion fish > ~/.config/fish/completions/orcher.fish

Supported shells: bash, zsh, fish, powershell, elvish


Configuration File

The CLI configuration lives at ~/.orcher/config.yaml and uses kubectl-style contexts for managing multiple environments.

Example Configuration

1
current-context: local
2
current-profile: default
3
4
contexts:
5
local:
6
server: "http://localhost:8080"
7
auth:
8
type: none
9
timeout: "30s"
10
namespace: default
11
12
production:
13
server: "https://orcher.example.com"
14
auth:
15
type: token
16
token-ref: prod-token
17
tls:
18
insecure: false
19
ca-cert: /path/to/ca.pem
20
client-cert: /path/to/cert.pem
21
client-key: /path/to/key.pem
22
timeout: "60s"
23
namespace: prod
24
25
profiles:
26
default:
27
output: table
28
namespace: default
29
log-level: info
30
show-managed-fields: false

Auth Types

Each context can use one of four auth types:

  • none — No authentication (local development)
  • token — Bearer token (stored in keychain, referenced by token-ref)
  • apikey — API key (stored in keychain, referenced by apikey-ref)
  • basic — Username/password

TLS Configuration

Each context can optionally configure TLS:

1
contexts:
2
secure-server:
3
server: "https://orcher.example.com"
4
tls:
5
insecure: false # Set true to skip verification
6
ca-cert: /path/to/ca.pem
7
client-cert: /path/to/cert.pem
8
client-key: /path/to/key.pem

Environment Variables

VariableDescription
ORCHER_CONFIGConfig file path (default: ~/.orcher/config.yaml)
ORCHER_CONTEXTOverride current context
ORCHER_NAMESPACEOverride namespace
ORCHER_SERVEROverride server URL
ORCHER_TOKENAPI token (highest priority, overrides stored credentials)
ORCHER_REDIS_URLRedis connection string
ORCHER_API_URLREST API address (the engine's HTTP port); defaults to the --server host on port 8080
ORCHER_VERBOSEEnable verbose logging
ORCHER_QUIETQuiet mode
NO_COLORDisable colored output
DATABASE_URLDatabase URL (for server start)

File Paths

ItemPath
Config directory~/.orcher/
Config file~/.orcher/config.yaml
Templates~/.orcher/templates/
Cache~/.orcher/cache/
Logs~/.orcher/logs/
CredentialsOS keychain (not on disk)