# langship CLI for the Langship control plane. Drive agents, environments, pipelines, credentials, and runs from your terminal — same API the web UI uses. ## Install ```bash pip install -e /Users/khushpatel2002/langship-restate/langship-cli # (once published: pip install langship) ``` Optional: `pip install pyyaml` to use `-o yaml` and YAML pipeline files. ## Setup ```bash langship login --api-url http://localhost:8090 # or just: langship login (prompts; default http://localhost:8090) ``` Saved to `~/.langship/config.toml`. Override per-invocation: ```bash LANGSHIP_API_URL=http://localhost:8090 langship agents list LANGSHIP_TOKEN=... langship agents list # if/when the API requires auth ``` There is no built-in default URL — you must `login` (or set `LANGSHIP_API_URL`) before any command other than `login`. ## Quick tour ```bash # Agents langship agents create --repo https://github.com/me/agent --pat ghp_... langship agents list langship agents get langship agents trigger # dispatch across followed envs # Environments (named, ORDERED list of pipelines = the promotion sequence) langship envs create dev -d "Auto-deploy on push" langship pipelines push pipeline.json # -> prints the new pipeline id langship envs add-pipeline dev langship envs reorder dev langship envs get dev # Agent follows an environment -> triggering it runs that env's pipelines langship agents follow-env dev langship agents trigger # Credentials (global pool — server needs FLOW_SECRET_KEY set) langship creds create prod-aws --type aws \ --aws-region us-east-1 --aws-account 123456789012 \ --aws-role-arn arn:aws:iam::123456789012:role/FlowDeployRole langship creds list # Runs langship runs list langship runs logs -f # stream live langship runs get ``` ## Commands ``` langship login [--api-url URL] [--token TOK] langship config-show langship version langship agents list [-o json|yaml] langship agents get [-o ...] langship agents create --repo [--pat ...] [--name ...] [--ref ...] langship agents delete [-y] langship agents trigger langship agents follow-env langship agents unfollow-env langship agents test-auth langship agents webhook install langship agents webhook uninstall langship envs list [-o ...] langship envs get [-o ...] langship envs create [-d ] langship envs update -d langship envs delete [-y] langship envs add-pipeline langship envs remove-pipeline langship envs reorder ... langship pipelines list [-o ...] langship pipelines get [-o json|yaml|table] langship pipelines push [--id ] [--name ...] langship pipelines delete [-y] langship creds list [-o ...] langship creds get [-o ...] langship creds create --type aws|gcp|kv [provider flags...] langship creds delete [-y] langship runs list [--limit N] [--pipeline ] [-o ...] langship runs get [-o ...] langship runs logs [-f] ``` ## Env vars - `LANGSHIP_API_URL` — overrides the saved API URL - `LANGSHIP_TOKEN` — overrides the saved auth token