Global flags
Section titled “Global flags”These work on every command.
| Flag | Description |
|---|---|
-o, --output |
Output format: table (default), json, yaml, quiet |
-p, --profile |
Configuration profile to use |
--debug |
Enable debug output |
--no-color |
Disable colored output |
Most commands are scoped to a workspace and an app. Both resolve in the order
flag, then environment (OMAZY_WORKSPACE / OMAZY_APP), then whatever
omazy workspace use pinned.
omazy admin
Section titled “omazy admin”Admin operations (privileged)
omazy admin [command] [flags]omazy admin analytics
Section titled “omazy admin analytics”Admin analytics
omazy admin analytics [command] [flags]omazy admin analytics data-sharing
Section titled “omazy admin analytics data-sharing”Data-sharing patterns analytics
omazy admin analytics data-sharing [command] [flags]omazy admin audit
Section titled “omazy admin audit”Audit log
omazy admin audit [command] [flags]omazy admin audit list
Section titled “omazy admin audit list”List audit entries
omazy admin audit list [command] [flags]| Flag | Description |
|---|---|
--action string |
Filter by action |
--actor string |
Filter by actor ID |
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy admin jobs
Section titled “omazy admin jobs”Background jobs (Asynq)
omazy admin jobs [command] [flags]omazy admin jobs delete
Section titled “omazy admin jobs delete”Delete a job
omazy admin jobs delete [command] [flags]omazy admin jobs get
Section titled “omazy admin jobs get”Show one job’s payload
omazy admin jobs get [command] [flags]omazy admin jobs list
Section titled “omazy admin jobs list”List jobs
omazy admin jobs list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
--queue string |
Queue (critical|default|low) |
--status string |
Status filter |
omazy admin jobs queues
Section titled “omazy admin jobs queues”Per-queue stats
omazy admin jobs queues [command] [flags]omazy admin jobs retry
Section titled “omazy admin jobs retry”Retry a failed job
omazy admin jobs retry [command] [flags]omazy admin metrics
Section titled “omazy admin metrics”Admin metrics
omazy admin metrics [command] [flags]omazy admin metrics bot-response
Section titled “omazy admin metrics bot-response”Bot response time percentiles
omazy admin metrics bot-response [command] [flags]omazy admin metrics dashboard
Section titled “omazy admin metrics dashboard”Top-level dashboard metrics
omazy admin metrics dashboard [command] [flags]omazy admin metrics messages-volume
Section titled “omazy admin metrics messages-volume”Message volume metrics
omazy admin metrics messages-volume [command] [flags]omazy admin metrics token-cost
Section titled “omazy admin metrics token-cost”Token cost metrics
omazy admin metrics token-cost [command] [flags]omazy admin sessions
Section titled “omazy admin sessions”Sessions admin
omazy admin sessions [command] [flags]omazy admin sessions force-close
Section titled “omazy admin sessions force-close”Force-close a session
omazy admin sessions force-close [command] [flags]| Flag | Description |
|---|---|
--reason string |
Required reason |
omazy admin sessions get
Section titled “omazy admin sessions get”Show one session with metadata
omazy admin sessions get [command] [flags]omazy admin sessions list
Section titled “omazy admin sessions list”List sessions across users
omazy admin sessions list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
--status string |
Filter by status |
omazy admin shares
Section titled “omazy admin shares”Cross-user data-share inventory
omazy admin shares [command] [flags]omazy admin shares get
Section titled “omazy admin shares get”Show one grant with audit trail
omazy admin shares get [command] [flags]omazy admin shares list
Section titled “omazy admin shares list”List grants across users
omazy admin shares list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy admin shares revoke
Section titled “omazy admin shares revoke”Force-revoke a grant
omazy admin shares revoke [command] [flags]| Flag | Description |
|---|---|
--notify-user |
Notify the grantee |
omazy admin users
Section titled “omazy admin users”User administration
omazy admin users [command] [flags]omazy admin users delete
Section titled “omazy admin users delete”Soft-delete a user
omazy admin users delete [command] [flags]omazy admin users get
Section titled “omazy admin users get”Show one user
omazy admin users get [command] [flags]omazy admin users list
Section titled “omazy admin users list”List users
omazy admin users list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
--role string |
Filter by role |
--status string |
Filter by status |
omazy admin users patch
Section titled “omazy admin users patch”Update role / status
omazy admin users patch [command] [flags]| Flag | Description |
|---|---|
--role string |
New role |
--status string |
New status |
omazy agent
Section titled “omazy agent”Agent configuration: model, knowledge, and Brief
omazy agent [command] [flags]| Flag | Description |
|---|---|
-a, --app omazy config set app |
App handle (default: OMAZY_APP, or omazy config set app) |
-w, --workspace omazy config set workspace |
Workspace handle (default: OMAZY_WORKSPACE, or omazy config set workspace) |
omazy agent brief
Section titled “omazy agent brief”The agent’s Brief: structured instructions that compile into its prompt
omazy agent brief [command] [flags]omazy agent brief add
Section titled “omazy agent brief add”Append an instruction item to the Brief
omazy agent brief add [command] [flags]| Flag | Description |
|---|---|
--body string |
Instruction text |
--file string |
Read instruction from a file (‘-’ for stdin) |
--section string |
Brief section (default “general”) |
--title string |
Short label for the instruction |
omazy agent brief delete
Section titled “omazy agent brief delete”Remove an instruction item
omazy agent brief delete [command] [flags]omazy agent brief publish
Section titled “omazy agent brief publish”Compile the Brief into the agent’s live system prompt
omazy agent brief publish [command] [flags]omazy agent brief show
Section titled “omazy agent brief show”Show the Brief
omazy agent brief show [command] [flags]omazy agent knowledge
Section titled “omazy agent knowledge”Agent knowledge documents
omazy agent knowledge [command] [flags]omazy agent knowledge add
Section titled “omazy agent knowledge add”Add a knowledge document from –body, –file, or stdin
omazy agent knowledge add [command] [flags]| Flag | Description |
|---|---|
--body string |
Document content |
--file string |
Read content from a file (‘-’ for stdin) |
--kind string |
Document kind (default “text”) |
--source-url string |
Origin URL, shown as the citation |
--title string |
Document title (required) |
omazy agent knowledge delete
Section titled “omazy agent knowledge delete”Delete a knowledge document
omazy agent knowledge delete [command] [flags]omazy agent knowledge get
Section titled “omazy agent knowledge get”Show one knowledge document
omazy agent knowledge get [command] [flags]omazy agent knowledge list
Section titled “omazy agent knowledge list”List knowledge documents
omazy agent knowledge list [command] [flags]| Flag | Description |
|---|---|
--limit int |
Maximum documents to return |
--search string |
Filter by free text |
omazy agent knowledge reindex
Section titled “omazy agent knowledge reindex”Re-embed a document for retrieval
omazy agent knowledge reindex [command] [flags]omazy agent prompts
Section titled “omazy agent prompts”List the agent’s published prompt versions
omazy agent prompts [command] [flags]omazy agent set
Section titled “omazy agent set”Update agent settings
omazy agent set [command] [flags]| Flag | Description |
|---|---|
--active string |
Enable or disable the agent (true|false) |
--model string |
Model id (e.g. openai/gpt-4o) |
--name string |
Agent display name |
--temperature string |
Sampling temperature |
omazy agent show
Section titled “omazy agent show”Show the app’s agent configuration
omazy agent show [command] [flags]omazy agent suggestions
Section titled “omazy agent suggestions”Show the agent’s open-question suggestion pills
omazy agent suggestions [command] [flags]omazy agent test
Section titled “omazy agent test”Send a message to the agent in a throwaway preview session
omazy agent test [command] [flags]| Flag | Description |
|---|---|
-m, --message string |
Message to send (required) |
omazy auth
Section titled “omazy auth”Sign in and manage authorized CLI installs
omazy auth [command] [flags]omazy auth installs
Section titled “omazy auth installs”List and revoke the CLI installs registered to your account
omazy auth installs [command] [flags]omazy auth installs list
Section titled “omazy auth installs list”List installs
omazy auth installs list [command] [flags]omazy auth installs revoke
Section titled “omazy auth installs revoke”Revoke one install and its whole token family
omazy auth installs revoke [command] [flags]omazy auth login
Section titled “omazy auth login”Sign in and bind this machine as an authorized CLI install
omazy auth login [command] [flags]| Flag | Description |
|---|---|
--browser |
Browser consent screen with a loopback listener |
--browser-only |
Print the consent URL instead of opening a browser |
--callback-port int |
Loopback callback port for –browser (0 = auto) |
--device |
Device-code flow: authorize from another machine |
--email string |
Email address to sign in with |
--magic |
Send a magic link instead of a code |
--password |
Prompt for a password instead of emailing a code |
--provider string |
Social provider (google|apple) |
--scope strings |
OAuth scopes (comma-separated; default from profile) |
omazy auth logout
Section titled “omazy auth logout”Revoke this install (or –all installs) and clear local credentials
omazy auth logout [command] [flags]| Flag | Description |
|---|---|
--all |
Revoke every install for this user |
omazy auth refresh
Section titled “omazy auth refresh”Force a token refresh now
omazy auth refresh [command] [flags]omazy auth register
Section titled “omazy auth register”Create a new Omazy account
omazy auth register [command] [flags]| Flag | Description |
|---|---|
--email string |
|
--first-name string |
First name |
--last-name string |
Last name |
--password string |
Password |
omazy auth scopes
Section titled “omazy auth scopes”List the scopes the CLI can request
omazy auth scopes [command] [flags]omazy auth status
Section titled “omazy auth status”Show the current install, scopes, and expiry
omazy auth status [command] [flags]omazy auth switch-business
Section titled “omazy auth switch-business”Re-issue tokens bound to a different authorized business
omazy auth switch-business [command] [flags]omazy auth verify-email
Section titled “omazy auth verify-email”Complete email verification
omazy auth verify-email [command] [flags]| Flag | Description |
|---|---|
--token string |
Email verification token |
omazy auth whoami
Section titled “omazy auth whoami”Show the authenticated user as the middleware sees them
omazy auth whoami [command] [flags]omazy bot
Section titled “omazy bot”Bots: middleware catalog
omazy bot [command] [flags]omazy bot catalog
Section titled “omazy bot catalog”Browse the public bot catalog
omazy bot catalog [command] [flags]omazy bot catalog get
Section titled “omazy bot catalog get”Show one catalog bot
omazy bot catalog get [command] [flags]omazy bot catalog list
Section titled “omazy bot catalog list”List catalog bots
omazy bot catalog list [command] [flags]| Flag | Description |
|---|---|
--app string |
App ID |
--category string |
Category filter |
--cursor string |
Pagination cursor |
--featured-only |
Featured only |
--per-page int |
Page size |
--search string |
Free-text search |
omazy channel
Section titled “omazy channel”Channels: availability, health, and takeoff
omazy channel [command] [flags]omazy channel availability
Section titled “omazy channel availability”Channels usable in the current context
omazy channel availability [command] [flags]| Flag | Description |
|---|---|
--app string |
App ID |
--conversation string |
Conversation ID |
--current string |
Current channel |
--takeoff-only |
Only takeoff-eligible channels |
omazy channel health
Section titled “omazy channel health”Channel connectivity health
omazy channel health [command] [flags]omazy channel takeoff
Section titled “omazy channel takeoff”Generate a deep-link channel handoff URL
omazy channel takeoff [command] [flags]| Flag | Description |
|---|---|
--conversation string |
Conversation ID |
--to string |
Target channel slug |
omazy chat
Section titled “omazy chat”Chat sessions, messages, and conversation context
omazy chat [command] [flags]omazy chat agents
Section titled “omazy chat agents”Show agent participation rollup
omazy chat agents [command] [flags]omazy chat archive
Section titled “omazy chat archive”Archive a session
omazy chat archive [command] [flags]omazy chat around
Section titled “omazy chat around”Context window of messages around a target
omazy chat around [command] [flags]| Flag | Description |
|---|---|
--message string |
Target message ID |
omazy chat context
Section titled “omazy chat context”Read / patch conversation context (OCC)
omazy chat context [command] [flags]omazy chat context get
Section titled “omazy chat context get”Get current context (and OCC version)
omazy chat context get [command] [flags]omazy chat context patch
Section titled “omazy chat context patch”Patch context (uses If-Match unless –force)
omazy chat context patch [command] [flags]| Flag | Description |
|---|---|
--force |
Skip OCC and overwrite |
--json string |
Context JSON object (default “{}”) |
omazy chat get
Section titled “omazy chat get”Show one session
omazy chat get [command] [flags]omazy chat list
Section titled “omazy chat list”List chat sessions
omazy chat list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
--status string |
Filter by status |
omazy chat messages
Section titled “omazy chat messages”List messages
omazy chat messages [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy chat new
Section titled “omazy chat new”Create or resume a chat session
omazy chat new [command] [flags]| Flag | Description |
|---|---|
--app string |
App ID |
--bot string |
Bot profile ID |
--type string |
Session type |
omazy chat pin
Section titled “omazy chat pin”Pin a message
omazy chat pin [command] [flags]omazy chat pinned
Section titled “omazy chat pinned”List pinned messages
omazy chat pinned [command] [flags]omazy chat send
Section titled “omazy chat send”Send a message
omazy chat send [command] [flags]| Flag | Description |
|---|---|
--body string |
Message body |
--content-type string |
Message content type |
--reply-to string |
Parent message ID |
omazy chat status
Section titled “omazy chat status”Update session status
omazy chat status [command] [flags]omazy chat unpin
Section titled “omazy chat unpin”Unpin a message
omazy chat unpin [command] [flags]omazy config
Section titled “omazy config”Manage CLI configuration + profiles
omazy config [command] [flags]omazy config get
Section titled “omazy config get”Read a config value
omazy config get [command] [flags]omazy config profile
Section titled “omazy config profile”Show / switch profiles
omazy config profile [command] [flags]omazy config set
Section titled “omazy config set”Write a config value
omazy config set [command] [flags]omazy gdpr
Section titled “omazy gdpr”GDPR: erasure (Article 17) + export (Article 20)
omazy gdpr [command] [flags]omazy gdpr erase
Section titled “omazy gdpr erase”Erasure operations
omazy gdpr erase [command] [flags]omazy gdpr erase list
Section titled “omazy gdpr erase list”List erasure requests
omazy gdpr erase list [command] [flags]omazy gdpr erase request
Section titled “omazy gdpr erase request”Initiate an erasure request
omazy gdpr erase request [command] [flags]| Flag | Description |
|---|---|
--reason string |
Optional reason |
--scope string |
Erasure scope: full|session|message (default “full”) |
--target-id string |
Target session/message ID (when scope is not full) |
omazy gdpr erase session
Section titled “omazy gdpr erase session”Erase a single session
omazy gdpr erase session [command] [flags]omazy gdpr erase status
Section titled “omazy gdpr erase status”Show one erasure request
omazy gdpr erase status [command] [flags]omazy gdpr export
Section titled “omazy gdpr export”Export your data (streams JSON to stdout or –output-file)
omazy gdpr export [command] [flags]| Flag | Description |
|---|---|
--force |
Allow streaming to a TTY |
--output-file string |
Write to file instead of stdout |
omazy health
Section titled “omazy health”Probe middleware health
omazy health [command] [flags]omazy health detailed
Section titled “omazy health detailed”Probe middleware detailed health (DB, Redis, etc.)
omazy health detailed [command] [flags]omazy inbox
Section titled “omazy inbox”Live conversations: claim, reply, transfer, resolve
omazy inbox [command] [flags]| Flag | Description |
|---|---|
-a, --app omazy config set app |
App handle (default: OMAZY_APP, or omazy config set app) |
-w, --workspace omazy config set workspace |
Workspace handle (default: OMAZY_WORKSPACE, or omazy config set workspace) |
omazy inbox claim
Section titled “omazy inbox claim”Assign the conversation to yourself
omazy inbox claim [command] [flags]omazy inbox dispositions
Section titled “omazy inbox dispositions”List the resolution reasons configured for this app
omazy inbox dispositions [command] [flags]omazy inbox escalate
Section titled “omazy inbox escalate”Raise the conversation for supervisor attention
omazy inbox escalate [command] [flags]| Flag | Description |
|---|---|
--reason string |
Why it needs escalating |
omazy inbox heartbeat
Section titled “omazy inbox heartbeat”Mark yourself online (presence ages out without this)
omazy inbox heartbeat [command] [flags]omazy inbox list
Section titled “omazy inbox list”List conversations in the inbox
omazy inbox list [command] [flags]| Flag | Description |
|---|---|
--assignee string |
Filter by assigned operator id, or ‘me’ |
--limit int |
Maximum conversations to return |
--status string |
Filter by status (open, pending, resolved, …) |
omazy inbox messages
Section titled “omazy inbox messages”Show a conversation transcript
omazy inbox messages [command] [flags]| Flag | Description |
|---|---|
--limit int |
Maximum messages to return |
omazy inbox presence
Section titled “omazy inbox presence”Show which operators are online
omazy inbox presence [command] [flags]omazy inbox reply
Section titled “omazy inbox reply”Send an operator reply into the conversation
omazy inbox reply [command] [flags]| Flag | Description |
|---|---|
-m, --message string |
Reply text |
--saved-response string |
Send a saved response by key instead |
omazy inbox resolve
Section titled “omazy inbox resolve”Close the conversation with a disposition
omazy inbox resolve [command] [flags]| Flag | Description |
|---|---|
--disposition omazy inbox dispositions |
Resolution reason key (see omazy inbox dispositions) |
--note string |
Closing note |
omazy inbox show
Section titled “omazy inbox show”Show one conversation with its operator metadata
omazy inbox show [command] [flags]omazy inbox transfer
Section titled “omazy inbox transfer”Hand the conversation to another operator
omazy inbox transfer [command] [flags]| Flag | Description |
|---|---|
--note string |
Handover note |
--to string |
Target operator user id (required) |
omazy inbox why
Section titled “omazy inbox why”Show why the agent answered as it did (retrieval + tool calls)
omazy inbox why [command] [flags]omazy mcp-server
Section titled “omazy mcp-server”Browse the public MCP servers catalog
omazy mcp-server [command] [flags]omazy mcp-server list
Section titled “omazy mcp-server list”List public MCP servers
omazy mcp-server list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy notification
Section titled “omazy notification”User notifications
omazy notification [command] [flags]omazy notification list
Section titled “omazy notification list”List notifications
omazy notification list [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
--unread-only |
Filter to unread |
omazy notification read
Section titled “omazy notification read”Mark one notification as read
omazy notification read [command] [flags]omazy notification read-all
Section titled “omazy notification read-all”Mark every notification as read
omazy notification read-all [command] [flags]omazy ops
Section titled “omazy ops”DevOps scripts wrapped over SSH
omazy ops [command] [flags]omazy ops backup
Section titled “omazy ops backup”Run Postgres + ClickHouse backup
omazy ops backup [command] [flags]omazy ops connect
Section titled “omazy ops connect”Open an SSH tunnel via the configured host
omazy ops connect [command] [flags]omazy ops deploy
Section titled “omazy ops deploy”Build, push, and restart on remote
omazy ops deploy [command] [flags]| Flag | Description |
|---|---|
--service string |
Single service to redeploy |
omazy ops health-check
Section titled “omazy ops health-check”Probe endpoints + DB/Redis on remote
omazy ops health-check [command] [flags]omazy ops logs
Section titled “omazy ops logs”Tail remote service logs
omazy ops logs [command] [flags]| Flag | Description |
|---|---|
--follow |
Follow |
--service string |
Service name |
--tail int |
Lines to tail |
omazy ops migrate
Section titled “omazy ops migrate”Database migrations
omazy ops migrate [command] [flags]| Flag | Description |
|---|---|
--yes |
Confirm destructive operation |
omazy ops migrate create
Section titled “omazy ops migrate create”Create a new migration file
omazy ops migrate create [command] [flags]| Flag | Description |
|---|---|
--name string |
Migration name |
omazy ops migrate down
Section titled “omazy ops migrate down”Roll back one migration (destructive: requires –yes)
omazy ops migrate down [command] [flags]omazy ops migrate up
Section titled “omazy ops migrate up”Apply pending migrations
omazy ops migrate up [command] [flags]omazy ops restart
Section titled “omazy ops restart”docker compose restart
omazy ops restart [command] [flags]| Flag | Description |
|---|---|
--service string |
Service name |
omazy ops setup
Section titled “omazy ops setup”Initial server provisioning (interactive)
omazy ops setup [command] [flags]omazy ouchat
Section titled “omazy ouchat”OU AI personal assistant
omazy ouchat [command] [flags]omazy ouchat context
Section titled “omazy ouchat context”Show the assistant’s aggregated context
omazy ouchat context [command] [flags]omazy ouchat plan
Section titled “omazy ouchat plan”Ask OU AI to plan a goal
omazy ouchat plan [command] [flags]| Flag | Description |
|---|---|
--goal string |
What you want to accomplish (required) |
omazy ouchat start
Section titled “omazy ouchat start”Open an OU AI session
omazy ouchat start [command] [flags]| Flag | Description |
|---|---|
--app-id string |
Bind the session to an app |
omazy ouchat suggest
Section titled “omazy ouchat suggest”Ask OU AI for next-step suggestions
omazy ouchat suggest [command] [flags]| Flag | Description |
|---|---|
-q, --query string |
Context for the suggestions |
omazy realtime
Section titled “omazy realtime”Realtime WebSocket fan-out
omazy realtime [command] [flags]omazy realtime connect
Section titled “omazy realtime connect”Subscribe to realtime events (line-delimited JSON to stdout)
omazy realtime connect [command] [flags]| Flag | Description |
|---|---|
--topic strings |
Topic filter (repeatable) |
--watch |
Keep streaming until interrupted (default true) |
omazy search
Section titled “omazy search”Full-text search via OpenSearch
omazy search [command] [flags]omazy search conversations
Section titled “omazy search conversations”Search conversations
omazy search conversations [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy search messages
Section titled “omazy search messages”Search messages
omazy search messages [command] [flags]| Flag | Description |
|---|---|
--conversation string |
Limit to one conversation |
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy search typeahead
Section titled “omazy search typeahead”Autocomplete suggestions
omazy search typeahead [command] [flags]omazy server-admin
Section titled “omazy server-admin”Wraps middleware cmd/admin over SSH (promote/whoami)
omazy server-admin [command] [flags]omazy server-admin promote
Section titled “omazy server-admin promote”Promote a user (idempotent + audited)
omazy server-admin promote [command] [flags]| Flag | Description |
|---|---|
--dry-run |
Print the SSH command without executing |
--email string |
User email |
--role string |
Role (admin|support|analyst) |
omazy server-admin whoami
Section titled “omazy server-admin whoami”Read-only user lookup
omazy server-admin whoami [command] [flags]| Flag | Description |
|---|---|
--email string |
User email |
omazy share
Section titled “omazy share”MCP data-share grants
omazy share [command] [flags]omazy share audit
Section titled “omazy share audit”Audit log for your grants
omazy share audit [command] [flags]| Flag | Description |
|---|---|
--cursor string |
Pagination cursor |
--limit int |
Page size |
omazy share create
Section titled “omazy share create”Mint a new data-share grant
omazy share create [command] [flags]| Flag | Description |
|---|---|
--expires string |
RFC 3339 expiry timestamp |
--mcp-server string |
MCP server ID |
--scopes strings |
Scopes (comma-separated) |
omazy share get
Section titled “omazy share get”Show one grant
omazy share get [command] [flags]omazy share list
Section titled “omazy share list”List your grants
omazy share list [command] [flags]| Flag | Description |
|---|---|
--status string |
Filter by status (active|revoked|expired) |
omazy share revoke
Section titled “omazy share revoke”Revoke a grant
omazy share revoke [command] [flags]omazy user
Section titled “omazy user”User self-service
omazy user [command] [flags]omazy user me
Section titled “omazy user me”About the current user
omazy user me [command] [flags]omazy user me avatar
Section titled “omazy user me avatar”Upload an avatar image
omazy user me avatar [command] [flags]omazy user me settings
Section titled “omazy user me settings”Read / write settings
omazy user me settings [command] [flags]omazy user me settings get
Section titled “omazy user me settings get”Show settings
omazy user me settings get [command] [flags]omazy user me settings set
Section titled “omazy user me settings set”Patch one setting
omazy user me settings set [command] [flags]omazy user me show
Section titled “omazy user me show”Show profile
omazy user me show [command] [flags]omazy user me update
Section titled “omazy user me update”Patch profile fields
omazy user me update [command] [flags]| Flag | Description |
|---|---|
--bio string |
Bio |
--first-name string |
First name |
--language string |
Language (BCP 47) |
--last-name string |
Last name |
--timezone string |
Timezone (IANA) |
omazy widget
Section titled “omazy widget”Live-chat widget: deployments, config, publish, metrics
omazy widget [command] [flags]| Flag | Description |
|---|---|
-a, --app omazy config set app |
App handle (default: OMAZY_APP, or omazy config set app) |
-w, --workspace omazy config set workspace |
Workspace handle (default: OMAZY_WORKSPACE, or omazy config set workspace) |
omazy widget config
Section titled “omazy widget config”Widget appearance + behaviour config
omazy widget config [command] [flags]omazy widget config features
Section titled “omazy widget config features”Show the deployment’s feature toggles
omazy widget config features [command] [flags]omazy widget config get
Section titled “omazy widget config get”Print the widget’s config as JSON
omazy widget config get [command] [flags]omazy widget config set
Section titled “omazy widget config set”Replace the widget config from a JSON file or stdin
omazy widget config set [command] [flags]| Flag | Description |
|---|---|
-f, --file string |
JSON file to read (‘-’ for stdin) (default “-”) |
omazy widget create
Section titled “omazy widget create”Create a widget deployment
omazy widget create [command] [flags]| Flag | Description |
|---|---|
--name string |
Deployment name (required) |
omazy widget domains
Section titled “omazy widget domains”List domains the widget has been seen loading on
omazy widget domains [command] [flags]omazy widget events
Section titled “omazy widget events”Recent widget events
omazy widget events [command] [flags]| Flag | Description |
|---|---|
--limit int |
Maximum events to return |
omazy widget list
Section titled “omazy widget list”List the app’s widget deployments
omazy widget list [command] [flags]omazy widget metrics
Section titled “omazy widget metrics”Conversation and engagement counters
omazy widget metrics [command] [flags]| Flag | Description |
|---|---|
--since string |
RFC3339 start time |
omazy widget publish
Section titled “omazy widget publish”Promote the staged config to the live deployment
omazy widget publish [command] [flags]omazy widget show
Section titled “omazy widget show”Show a deployment with its current config
omazy widget show [command] [flags]omazy widget snippet
Section titled “omazy widget snippet”Print the HTML embed snippet for a widget
omazy widget snippet [command] [flags]omazy widget verify
Section titled “omazy widget verify”Check that the embed snippet is live on a page
omazy widget verify [command] [flags]| Flag | Description |
|---|---|
--url string |
Page URL to fetch and inspect (required) |
omazy workspace
Section titled “omazy workspace”Workspaces: membership, apps, and the active selection
omazy workspace [command] [flags]| Flag | Description |
|---|---|
-a, --app omazy config set app |
App handle (default: OMAZY_APP, or omazy config set app) |
-w, --workspace omazy config set workspace |
Workspace handle (default: OMAZY_WORKSPACE, or omazy config set workspace) |
omazy workspace apps
Section titled “omazy workspace apps”Apps in the workspace
omazy workspace apps [command] [flags]omazy workspace apps create
Section titled “omazy workspace apps create”Create an app (and its agent) in the workspace
omazy workspace apps create [command] [flags]| Flag | Description |
|---|---|
--handle string |
URL handle (defaults to a slug of –name) |
--name string |
Display name (required) |
omazy workspace apps list
Section titled “omazy workspace apps list”List apps
omazy workspace apps list [command] [flags]omazy workspace apps show
Section titled “omazy workspace apps show”Show the active app
omazy workspace apps show [command] [flags]omazy workspace capabilities
Section titled “omazy workspace capabilities”Show your resolved permissions in the workspace
omazy workspace capabilities [command] [flags]omazy workspace current
Section titled “omazy workspace current”Print the pinned workspace and app
omazy workspace current [command] [flags]omazy workspace list
Section titled “omazy workspace list”List the workspaces you belong to
omazy workspace list [command] [flags]omazy workspace members
Section titled “omazy workspace members”List workspace members
omazy workspace members [command] [flags]omazy workspace show
Section titled “omazy workspace show”Show the active workspace
omazy workspace show [command] [flags]omazy workspace use
Section titled “omazy workspace use”Pin the workspace future commands default to
omazy workspace use [command] [flags]| Flag | Description |
|---|---|
--app-handle string |
Also pin this app handle |