Routebase.Cli
1.0.1
dotnet tool install --global Routebase.Cli --version 1.0.1
dotnet new tool-manifest
dotnet tool install --local Routebase.Cli --version 1.0.1
#tool dotnet:?package=Routebase.Cli&version=1.0.1
nuke :add-package Routebase.Cli --version 1.0.1
Routebase CLI
Run your Routebase API tests, security scans, environment promotions and documentation sync from a terminal or a CI pipeline.
This is a client for Routebase — it needs an account and an API key. It is not a standalone testing tool.
Install
dotnet tool install --global Routebase.Cli
The command is routebase.
Configure
Create an API key under Settings → API Keys in the app, then:
routebase config set-api-key "$ROUTEBASE_API_KEY"
routebase config set-region us # only if your organization is hosted in the US
routebase config show
Region matters. One host serves both the EU and the US region, and requests
without a region signal are served from the EU. If your organization is hosted in the
US, either run config set-region us or set ROUTEBASE_REGION=us — otherwise your key
is looked up in the wrong region and the run fails at authentication. EU organizations
need nothing. In CI the environment variable is usually the better fit; it takes
precedence over the stored value.
Commands
| Command | What it does |
|---|---|
routebase run <project-id> <suite-id> |
Runs a test suite and exits non-zero when it fails |
routebase scan <project-id> <profile-id> |
Runs a security scan, gates on --fail-on <severity>, exports SARIF |
routebase promote <spec> <version> --env <name> |
Pins a spec version to an environment after a deploy |
routebase docs pull --project <id> / docs push --project <id> |
Docs-as-code: sync a documentation version to and from Markdown files |
routebase list suites <project-id> |
Lists the test suites in a project |
routebase config |
Stores API key, base URL, region and default project |
Run routebase <command> --help for the full option list.
Exit codes
| Code | Meaning |
|---|---|
0 |
Success |
1 |
The run failed — tests failed, or a finding tripped --fail-on |
2 |
Configuration error (missing API key, bad flag) |
3 |
Network error, or the run did not complete |
4 |
Authentication error (bad or insufficient API key) |
5 |
Project, suite or profile not found |
6 |
Conflict — a page changed remotely since docs pull |
Documentation
Full guides: https://docs.routebase.dev
Licence
Proprietary. Use requires a Routebase subscription or trial — see the bundled
LICENSE.md and https://routebase.dev/terms.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
This package has no dependencies.