OwnStack

Install the OwnStack CLI

The OwnStack CLI is a Bash script driver plus a small set of helper libraries. macOS and Linux are first-class; Windows users should run it under WSL.

Install

The recommended install is a one-liner that downloads the executable to ~/bin and the helper libraries to ~/.ownstack/cli:

$ curl -sSL https://ownstack.org/cli/install.sh | bash

Verify:

$ ownstack --version
ownstack 0.x.x
Tip

If you've already cloned the CLI repo for development (~/dev/ownstack/cli), you can symlink instead: ln -s ~/dev/ownstack/cli/bin/ownstack ~/bin/ownstack. The CLI resolves its lib path relative to the script.

Pick a control plane

The CLI talks to a control plane. By default that's the hosted one at https://api.ownstack.org. If you're self-hosting, point at your own URL when you log in.

$ ownstack login                                      # hosted
$ ownstack login --api=https://api.example.com        # self-hosted

Login opens a browser, completes the OAuth flow, and writes the resulting token to ~/.ownstack/profiles/<name>.

Profiles

Each control-plane endpoint is a profile. Run multiple at once if you have a hosted account and a self-hosted instance, or one profile per organization.

$ ownstack profile list
  budbooks
* haven (active)
  ownstack

$ ownstack profile show
API URL: https://api.ownstack.org
Active profile: ownstack
Token: 9242e4bc…

$ ownstack profile use haven
Always check before state-changing commands

The CLI does not warn you when deploy, db, or ssh would run against the wrong profile. Run ownstack profile show first if you've been switching contexts.

Where things live

PathWhat's there
~/bin/ownstackThe CLI executable.
~/.ownstack/cli/Helper libraries (lib/db.sh, lib/control_plane.sh, etc.).
~/.ownstack/profiles/<name>One file per profile, holding API URL and token.
~/.ownstack/configGlobal config (active profile, defaults).
./.ownstack-configPer-repo: links the local checkout to a specific app on the active control plane.

Next

You're ready to deploy your first app.