OpenSana Docs

Install the CLI

Install or run the OpenSana CLI on demand.

You can run the CLI without installing it globally, or install it once so opensana is available in your shell.

Run Without Installing

npx @opensana/cli --help
npx @opensana/cli connect

Install Globally

npm install -g @opensana/cli
opensana --help

Platform Notes

  • macOS and Linux use the opensana launcher directly.
  • Windows users can still invoke it as opensana after npm install -g.

Verify The Install

opensana --help
opensana status

If you have not configured any profiles yet, the CLI will tell you to run opensana setup.

On this page