Omics-OSDocs
Omics-OS Cloud

Omics-OS CLI

Connect to Omics-OS Cloud from your terminal with the omics-os command

Install

Requires Node.js 22 or later. If @omicsos/lobster 0.4 is installed, run npm uninstall -g @omicsos/lobster first: both packages install the lobster-cli command.

npm install -g omics-os

Verify:

omics-os --version

Login

omics-os login opens your browser for Omics-OS authentication and stores first-party CLI credentials locally. No Cognito tokens are relayed to your machine.

omics-os login                  # browser-based login
omics-os login --device         # browserless / SSH: prints a URL + code to authorize from any browser
omics-os login --tenant <slug>  # sign in to an organisation's subdomain
omics-os login --api-key <key>  # API key

Key Commands

CommandWhat It Does
omics-os loginAuthenticate via browser
omics-os login --deviceAuthenticate from SSH / headless environments
omics-os logoutSign out and remove local credentials
omics-os lobster chatStart an interactive cloud chat session
omics-os lobster chat --session-id <id>Resume a specific session
omics-os lobster query "<question>"Ask one question and print the answer
omics-os statusShow account info and usage
omics-os lobster session listList your sessions
omics-os lobster files list <session>List files in a session
omics-os lobster projects listList your Omics-OS Cloud projects
omics-os lobster vector search "<query>"Semantic search across ontology collections
omics-os upload <paths> --project <id>Upload large files into a project (organisations with uploads enabled)
omics-os biovaultBioVault drafts and runs
omics-os doctorCheck the installation

The full guide, with every command and the move from @omicsos/lobster 0.4, is Omics-OS CLI.

Global Flags

FlagDescription
--jsonOutput as JSON for scripting
--endpoint <url>Override API endpoint
--profile <name>Use this credential profile
--no-colorDisable colored output
--verboseShow HTTP request details

API Keys

For CI/headless use, generate an API key (omk_...) in your workspace settings and supply it via environment variable:

export OMICS_OS_API_KEY=omk_your_key_here
omics-os lobster session list --json

On this page