sbx

Short for sandbox, Orchestra CLI tool: sbx up

➜  sbx help

NAME
  sbx - orchestra cli

COMMANDS

  sbx help
      up
      down
      name
      dash
      logs
      web
      graphiql
      version
      info
      progress
      headlamp

DESCRIPTION

  command     shorthand     description

  help                      shows the help message.
  up          u             spins up an orchestra sandbox.
  down                      tears down an orchestra sandbox.
  name        n             shows the sandbox name.
  dash        d             opens the dashboard in a browser.
  logs        l             opens the logs in a browser.
  web         w             opens the site in a browser.
  graphiql    g             opens graphql user interface in a browser.
  version     v             shows the version of the sbx cli.
  info        i             shows the summary of the sandbox.
  progress    p             opens deployment progress in a browser.
  headlamp    h             opens headlamp ( kubernetes dashboard ) in a browser.

USAGE:
  sbx <command> [flags]
  sbx up

Install / Upgrade

Requires GITHUB_TOKEN to be set in the environment.

brew

brew tap reverbdotcom/sbx [email protected]:reverbdotcom/sbx.git
brew update
brew install sbx

golang

export GOPRIVATE=github.com/reverbdotcom && go install github.com/reverbdotcom/sbx@main

bash

VERSION=<grab the latest tag> \
    curl \
        -s\
        -L \
        -o "/tmp/sbx-darwin-arm64.tar.gz" \
        "https://github.com/reverbdotcom/sbx/releases/download/${VERSION}/sbx-darwin-arm64.tar.gz" \
    && tar -xzf /tmp/sbx-darwin-arm64.tar.gz -C /tmp \
    && sudo mv /tmp/sbx /usr/local/bin/sbx

Release

Release is done for bash and brew installations. 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.