Skip to main content

Command-line interface for the Omnira Lead Engagement Platform

Project description

Omnira CLI

The command-line interface for the Omnira Lead Engagement Platform. Manage your leads, offerings, sales pipeline, and AI-driven outreach from your terminal — built for both human use and AI agent integration (Claude Code, OpenClaw).

Install

uv tool install omnira

Or with pipx:

pipx install omnira

Then authenticate with your Omnira API key — generate one at omnira.so/settings/api:

omnira login

Upgrade

uv tool upgrade omnira    # if installed with uv
pipx upgrade omnira       # if installed with pipx

Quick Start

omnira account                     # confirm authentication, see credits
omnira leads list                  # see your leads
omnira offerings list              # see your products/services
omnira pipeline summary            # pipeline overview
omnira hitl list                   # pending AI message approvals

Every command supports --help to discover its options:

omnira leads --help
omnira leads list --help

Use With AI Agents

The CLI is designed to be operated by AI agents like Claude Code. To set up an agent integration:

omnira agent install

This installs three things so Claude Code can operate your Omnira account with zero additional configuration:

  1. A skill file at .claude/skills/omnira/SKILL.md (command reference, ID system, workflow recipes)
  2. An MCP server entry in .claude/mcp_servers.json that auto-starts omnira mcp serve on the next Claude Code session
  3. A CLAUDE.md section pointing the agent at both

Pass --global to install to ~/.claude instead of the current project.

Restart Claude Code, and the agent will have ~90 typed MCP tools for every CLI capability (leads, offerings, outreach, pipeline, HITL, messages, sales config, content, plans, morning, aria, assets, calendar, contacts). The agent can also shell out to omnira <command> when it prefers — both paths hit the same API with the same partner auth.

Try asking:

"List my pending HITL messages and tell me which to approve"

MCP Server (Advanced)

If you want to run the MCP server manually (e.g. for a non-Claude-Code agent, or for testing):

omnira mcp serve                         # stdio transport (default)
omnira mcp serve --transport http --port 8087   # HTTP transport
omnira mcp list-tools                    # show all registered tools

What You Can Do

  • Leads — list, create, fetch new leads, enrich with GTM data, mark won/lost
  • Offerings — manage products/services, generate sales processes, configure templates
  • Outreach — launch campaigns, pause/resume, force steps, view conversations
  • Pipeline — create stages, move leads, view summary
  • HITL — review, approve, edit, or reject AI-generated messages
  • Messages — send SMS, email, and iMessage manually
  • Action Plans — review and approve AI-suggested next actions
  • Calendar — manage appointments and availability
  • Aria — chat with your AI business advisor

Run omnira --help to see all command groups.

Documentation

Full customer-facing docs live in docs/:

  • Getting started — install, API key, first commands.
  • Command reference — every command with syntax and examples.
  • Workflows — end-to-end recipes (morning review, launching outreach, closing deals, bulk enrichment).
  • Troubleshooting — error codes, safety checklist, credit/rate-limit guidance.

Output Formats

By default, output is formatted as a rich table when running interactively, or as JSON when piped:

omnira leads list                  # table view
omnira leads list -o json          # explicit JSON
omnira leads list | jq '.data.leads[].email'   # auto-detects pipe → JSON

Configuration

Configuration is stored in ~/.omnira/config.toml. You can manage multiple profiles:

omnira --profile staging login
omnira --profile staging leads list

Environment variables override config file values:

  • OMNIRA_API_KEY — your API key
  • OMNIRA_API_URL — gateway URL (defaults to https://api.omnira.so)
  • OMNIRA_PROFILE — active profile name
  • OMNIRA_OUTPUT — output format (auto, json, table, plain)

Support

License

Proprietary. © Omnira.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omnira-0.2.3.tar.gz (61.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

omnira-0.2.3-py3-none-any.whl (72.3 kB view details)

Uploaded Python 3

File details

Details for the file omnira-0.2.3.tar.gz.

File metadata

  • Download URL: omnira-0.2.3.tar.gz
  • Upload date:
  • Size: 61.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for omnira-0.2.3.tar.gz
Algorithm Hash digest
SHA256 b9cce24849b5d538bbc80a59d851913eba89c4e11656dca96ac32bcf93cee110
MD5 1c4261a79c8954a3308d9a9d5815aad9
BLAKE2b-256 3ca3a541b9ba82bf3880804a053425ae1b6c37ec9ecccad18e076181135cdca8

See more details on using hashes here.

Provenance

The following attestation bundles were made for omnira-0.2.3.tar.gz:

Publisher: publish-cli.yml on hpriehle/omnira

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file omnira-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: omnira-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 72.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for omnira-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 607b0666940c414d6a05f113e73abfb4d113779c126fbf6872b39d0ae1a2dc2a
MD5 135aeeb7b5584c31c1b073a83c918862
BLAKE2b-256 6bb172966750f56f460a8577c6e8999106accab5b266bbb1a2aedc2504079fa8

See more details on using hashes here.

Provenance

The following attestation bundles were made for omnira-0.2.3-py3-none-any.whl:

Publisher: publish-cli.yml on hpriehle/omnira

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page