apiome browse
Global options such as --base-url, --tenant and --json go before the command — see CLI reference. Exit codes are listed in Exit codes.
apiome browse
Open published projects and versions in the browse app.
apiome browse [OPTIONS] COMMAND [ARGS]...
Subcommands: open.
apiome browse open
Open a tenant, project or version page of the browse app in a web browser.
The browse app's address is APIOME_BROWSE_URL, else url in the [browse] section of the config file, else derived from --base-url: an api. host becomes browse., and a local API maps to the browse dev server on port 3001.
Exit codes: 0 opened (or printed); 2 bad PATH, no browse address, or an unknown --browser; 1 the browser could not be launched (use --print-url).
apiome browse open [OPTIONS] PATH
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
TARGET | text | yes | tenant, tenant/project, tenant/project/version, or a longer path such as 'tenant/project/compare?v1=2.0.0&v2=2.1.0'. Start with / for a path from the browse root. |
Options
| Option | Type | Default | Required | Description |
|---|---|---|---|---|
--print-url | flag | Print the URL instead of opening it (works without a display). | ||
--browser | text | Browser to use instead of the default (e.g. firefox, chrome, safari). |