sbx

Short for sandbox, Orchestra CLI tool: sbx up

➜  sbx help

NAME
  sbx - orchestra cli

USAGE
  sbx <command> [flags]

SANDBOX MANAGEMENT
  command     shorthand     description
  up          u             spins up an orchestra sandbox
  down                      tears down an orchestra sandbox
  name        n             shows the sandbox name
  info        i             shows the summary of the sandbox

BROWSER TOOLS
  command     shorthand     description
  progress    p             opens deployment progress in a browser
  dash        d             opens the datadog dashboard in a browser
  logs        l             opens the datadog logs in a browser
  web         w             opens the site in a browser
  graphiql    g             opens graphql user interface in a browser
  db                        database console explorer. Use 'sbx db help' for subcommands.

CLI TOOLS
  command     shorthand     description
  k8s                       kubernetes resources explorer. Use 'sbx k8s help' for subcommands
  console     c             opens a core rails console

CONFIGURATION & INFO
  command     shorthand     description
  env         e             shows the configured environment variables for the sbx cli
  version     v             shows the version of the sbx cli
  help        h             shows this help message

EXAMPLES
  sbx up
  sbx dash
  sbx k8s help

Install / Upgrade

Requires GITHUB_TOKEN to be set in the environment.

brew tap reverbdotcom/sbx git@github.com:reverbdotcom/sbx.git
brew update
brew install sbx

sbx self-updates on sbx up via brew upgrade.

Release

We support only darwin-arm64 ( macos m1 ) for now. To cut a new release, publish a new tag following semver.

Development

Important

This is public repo. Do not commit any secrets or sensitive information. Simpler for brew install. Though we can work with an internal repo with HOMEBREW_GITHUB_API_TOKEN set.

sbx.go is the main entry point for the CLI tool. Every command should be a go package. Commands are configured in commands/commands.go.

make <command>.run will build and run the command. This runs live.

Test

make test make <package>.test make <test file>

Test with another repo

Run, in any orchestra enabled repo.

export GOPRIVATE=github.com/reverbdotcom && go install github.com/reverbdotcom/sbx@your-test-branch

sbx now points to your branch version.