CLI Reference

semanticfed from @semanticfed/cli. A thin shell over @burdenoff/cli-sdk that mounts the SemanticFed product module plus shared platform modules.

• Package: @semanticfed/cli
• Repository: github.com/algoshred/semanticfed-cli

Install

# From npmjs (public)
npm install -g @semanticfed/cli
# or
bun add -g @semanticfed/cli

Environment selection

The CLI targets production by default. To switch environments, set BURDENOFF_ENV:

# Production (default)
semanticfed auth login

# Alpha
BURDENOFF_ENV=alpha semanticfed auth login

# Local
BURDENOFF_ENV=local semanticfed auth login

Override individual endpoints with env vars:

• SEMANTICFED_WORKSPACE_ENDPOINT
• SEMANTICFED_GLOBAL_ENDPOINT
• SEMANTICFED_OIDC_ISSUER

Default endpoints (production):

• Workspace gateway: https://graphqlworkspaces.burdenoff.com/workspaces/graphql
• Global gateway: https://graphql.burdenoff.com/global/graphql

Authentication

All workspace operations require dual-token auth (platform token + workspace token). The workspace token is issued automatically when you set a workspace.

User Authentication (OAuth2 Device Code)

# Login — opens browser for approval
semanticfed auth login

Common Auth Commands

semanticfed auth status                # Check current auth state
semanticfed auth token                 # Print platform access token
semanticfed auth token --workspace     # Print workspace token
semanticfed auth refresh               # Force token refresh
semanticfed auth logout                # Clear stored tokens

semanticfed workspace list             # List available workspaces
semanticfed workspace current          # Show current workspace
semanticfed workspace set <id>         # Switch workspace (re-issues token)

Token storage: ~/.config/semanticfed-cli/auth.json (mode 0600).

Command groups

Group	What
auth	Authentication (login, logout, status, token, refresh)
workspace	Workspace context (list, current, set)
semanticfed	SemanticFed federation & governed semantic layer (connectors, datasources, models, entities, dimensions, metrics, relationships, queries, access policies, health)
organizations	Organization management
tours	Product tours
rbac	Role-based access control
sandbox	Sandbox script execution
tags	Tags
files	Files
groups	Groups
conversations	Conversations
security	Security
integrations	Integrations
channels	Channels
scheduler	Scheduler
export	Data export
notifications	Notifications
support	Support
products	Products / feature flags
billing	Billing
store	Store
devportal	Developer portal
health	Health checks

Quick examples

semanticfed auth login
semanticfed workspace set <id>
semanticfed semanticfed connectors list
semanticfed semanticfed datasources list
semanticfed semanticfed models list
semanticfed semanticfed queries list
semanticfed tags create --key bug --label Bug
semanticfed rbac check <user> read project
semanticfed billing subscriptions list
semanticfed devportal apps list --status PUBLISHED

Output formats

All list/get commands support --format (-f): json, table, yaml.

Configuration

CLI settings are stored in ~/.config/semanticfed-cli/.

Development

git clone https://github.com/Algoshred/semanticfed-cli.git
cd semanticfed-cli
bun install

bun run dev              # Run CLI in dev mode (tsx)
bun run dev -- --help    # Dev mode with args
bun run build            # Compile TypeScript
bun run type-check       # Type checking
bun run lint             # ESLint
bun run format           # Prettier
bun run sanity           # All checks (format + lint + type-check + build)
bun run start            # Run compiled CLI

License

Proprietary — Burdenoff Consultancy Services Pvt. Ltd.