CLI reference
Sprintsail is driven from the terminal by the cf CLI. Everything below is a command you
can run today; the console does the same things through the same API.
Install the CLI (v8 or later) from its releases page, then point it at Sprintsail. There is no separate Sprintsail client to install.
Connecting
cf api https://api.sprintsail.com # point the CLI at Sprintsail
cf login --sso # sign in
cf target -o acme -s prod # choose org and space
cf target # show current target
cf logout
Orgs and spaces
cf orgs
cf spaces
cf create-space staging -o acme
cf delete-space staging -o acme
cf org acme
cf space prod
Apps
cf push orders-api # deploy from the current directory
cf push orders-api -i 3 -m 1G # with instance count and memory
cf push orders-api -c "node dist/server.js"
cf push orders-api --docker-image registry.example.com/acme/orders-api:v2
cf apps # everything in the current space
cf app orders-api # detail, including per-instance stats
cf delete orders-api
Lifecycle
cf start orders-api
cf stop orders-api
cf restart orders-api # restart instances
cf restage orders-api # rebuild from source, then restart
cf scale orders-api -i 3 -m 1G
Logs
cf logs orders-api # follow
cf logs orders-api --recent # recent history
Environment
cf env orders-api
cf set-env orders-api LOG_LEVEL debug
cf unset-env orders-api LOG_LEVEL
Remember to cf restart after changing the environment.
Services
cf marketplace # what you can provision
cf create-service postgres small orders-db
cf services # what exists in this space
cf service orders-db # detail and provisioning status
cf bind-service orders-api orders-db
cf unbind-service orders-api orders-db
cf delete-service orders-db
Restart the app after binding or unbinding.
Not supported
These commands exist in the CLI but are not available on Sprintsail today:
| Command | Status |
|---|---|
cf create-route with custom domains | Not self-service — talk to us |
cf enable-autoscaling and related | Not available; autoscaling is not built |
cf ssh | Not available |
If one of these is blocking you, tell us. What early-access teams actually need is what gets built next.
Using the console instead
Everything above has a console equivalent at console.sprintsail.com. Both talk to the same API with your identity, so the two never disagree — use whichever suits the moment.