Agent skill

Onyx CLI

by onyx-dot-app in onyx-dot-app/onyx

Query the Onyx knowledge base using the onyx-cli command. An agent skill from onyx-dot-app/onyx.

Custom licenceAuto-check passedKnowledge Management

Install Onyx CLI

skills CLI
$ npx skills add onyx-dot-app/onyx --skill onyx-cli -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install onyx-dot-app/onyx onyx-cli --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/onyx-dot-app/onyx.git skills-src && mkdir -p .claude/skills && cp -r skills-src/cli/internal/embedded .claude/skills/onyx-cli && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
onyx-cli
GitHub stars
32k
Used in
1 other repo
Token cost
~2.6k tokens
SKILL.md length
1,047 words
Files
2
Skills in repo
9
Repo updated
First seen
Licence
Custom licence

At a glance

Query the Onyx knowledge base using the onyx-cli command. An agent skill from onyx-dot-app/onyx.

  • Works in 4 steps: Check if installed → Install (if needed) → Check if configured → …
  • The user wants to search company documents
  • SKILL.md covers Prerequisites, Commands, Output Conventions and Exit Codes, plus 3 more sections
  • Runs Go scripts from its folder; calls jq and pip; reaches cloud.onyx.app

What it does

Onyx CLI is an agent skill from onyx-dot-app/onyx. Query the Onyx knowledge base using the onyx-cli command. Use when the user wants to search company documents, ask questions about internal knowledge, query connected data sources, or look up information stored in Onyx.

Its SKILL.md is about 2.6k tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file.

It sits in Knowledge Management, covering Knowledge bases. The repository describes itself as: Open Source AI Platform - AI Chat with advanced features that works with every LLM.

When your agent uses it

  • The user wants to search company documents
  • Ask questions about internal knowledge
  • Query connected data sources
  • Look up information stored in Onyx

Example prompts

  • “/onyx-cli”

Requirements

  • Python 3

Workflow steps

4 steps, taken from the step headings in SKILL.md.

  1. Check if installed
  2. Install (if needed)
  3. Check if configured
  4. Verify configuration

What it can do on your machine

Read from SKILL.md and the folder at commit fba54a4. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships script files (Go), which the agent can run.

    Shell commands in SKILL.md call:

    • jq
    • pip

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • cloud.onyx.app

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Onyx CLI loads about 2.6k tokens when it runs. Until then it costs about 57 tokens; SKILL.md has 1,047 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~57
When it runs · the whole SKILL.md, loaded when a task matches
~2.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,047 words (~2,648 tokens).

“onyx-cli is an agent's interface to the Onyx enterprise knowledge platform. It connects to company documents, apps, and people. Use it to answer questions that require internal knowledge — policies, docs, processes, data from connected sources (Confluence, Google Drive, Slack…”

— opening of SKILL.md by onyx-dot-app, Custom licence
name
onyx-cli

Read the full SKILL.md on GitHub

Files

SKILL.md and 1 other file in cli/internal/embedded of onyx-dot-app/onyx.

  • SKILL.md
  • embed.go

Open the folder on GitHubat commit fba54a4

Used in 2 other repositories

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in onyx-dot-app/onyx, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Onyx CLI next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Onyx CLI compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Onyx CLI this skillonyx-dot-app/onyx32k1 repos~2.6kAutomated safety check: PassCustom licence
Capture Conversationoutline/outline41k—~474Automated safety check: PassCustom licence
Project CairniBlinkQ/project-cairn2352 repos~861Automated safety check: PassMIT
LLM Wiki Knowledge GraphEgonex-AI/Understand-Anything86k1 repos~1.5kAutomated safety check: PassMIT
Find And Citeoutline/outline41k—~537Automated safety check: PassCustom licence
Xhs Virtual Productchenjin-cmd/xhs-virtual-product727—~862Automated safety check: PassMIT

Similar skills

  • Capture Conversation

    outline/outline

    Save the current conversation, a decision, or a set of notes as a document in an Outline collection; use when the user wants to keep what was discussed in their knowledge base.

    41k GitHub stars~474 tokensUpdated today
    Knowledge ManagementAuto-check passed
  • Project Cairn

    iBlinkQ/project-cairn

    Standardize how an AI-collaboration project turns work into reusable knowledge.

    235 GitHub starsUsed in 2 repos~861 tokens
    Knowledge ManagementAuto-check passed
  • LLM Wiki Knowledge Graph

    Egonex-AI/Understand-Anything

    Detects a Karpathy-pattern LLM wiki and builds an interactive knowledge graph with entities, implicit relationships and topic clusters.

    86k GitHub starsUsed in 1 repo~1.5k tokens
    Knowledge ManagementAuto-check passed
  • Find And Cite

    outline/outline

    Answer questions from the Outline knowledge base with quotes and links to the source documents; use when the user asks what the team knows, documented, or decided about a topic.

    41k GitHub stars~537 tokensUpdated today
    Knowledge ManagementAuto-check passed
  • Xhs Virtual Product

    chenjin-cmd/xhs-virtual-product

    This skill helps plan, select, produce, and market Xiaohongshu (RED) virtual/digital products — templates, knowledge bases, test tools, study materials.

    727 GitHub stars~862 tokensUpdated 7 days ago
    Knowledge ManagementAuto-check passed
  • Openkb

    VectifyAI/OpenKB

    A skill your agent uses when the user asks about content in their OpenKB knowledge base — research topics, concepts compiled from their documents, cross-document synthesis — or mentions openkb, an…

    4.7k GitHub starsUsed in 1 repo~2k tokens
    Knowledge ManagementAuto-check: warnings

More from onyx-dot-app/onyx

All 9 skills in this repo
  • Greploop

    onyx-dot-app/onyx

    Iteratively improves a PR (GitHub), MR (GitLab), or shelved changelist (Perforce) until Greptile gives it a 5/5 confidence score with zero unresolved comments.

    32k GitHub starsUsed in 4 repos~3.3k tokens
    Auto-check passed
  • Check PR

    onyx-dot-app/onyx

    Checks a GitHub, GitLab, or Perforce (p4) pull request (or merge request, or shelved changelist) for unresolved review comments, failing status checks, and incomplete PR descriptions.

    32k GitHub starsUsed in 2 repos~2.3k tokens
    Auto-check passed
  • Merge Dependabot PRs

    onyx-dot-app/onyx

    Triages and lands a batch of open Dependabot PRs in the Onyx repo, where main is gated exclusively by GitHub's merge queue: approves and enqueues green PRs, closes superseded duplicates, fixes…

    32k GitHub starsUsed in 1 repo~2.2k tokens
    Auto-check passed
  • Image Generation

    onyx-dot-app/onyx

    Generate or edit raster images (photos, illustrations, textures, sprites, mockups, logos, infographics) using the workspace's configured image-generation provider via onyx-cli image.

    32k GitHub starsUsed in 1 repo~1.7k tokens
    Auto-check passed
  • Playwright E2E Tests

    onyx-dot-app/onyx

    Write and maintain Playwright end-to-end tests for the Onyx application.

    32k GitHub starsUsed in 1 repo~2.8k tokens
    Auto-check: notes
  • Browser

    onyx-dot-app/onyx

    Core browser usage guide. An agent skill from onyx-dot-app/onyx.

    32k GitHub starsUsed in 1 repo~21k tokens
    Auto-check: warnings

Questions about Onyx CLI

What does Onyx CLI do?

Query the Onyx knowledge base using the onyx-cli command. An agent skill from onyx-dot-app/onyx. Onyx CLI is an agent skill from onyx-dot-app/onyx. Query the Onyx knowledge base using the onyx-cli command.

When should I use Onyx CLI?

Onyx CLI fits situations like: the user wants to search company documents; ask questions about internal knowledge; query connected data sources; look up information stored in Onyx.

How do I install Onyx CLI in Claude Code?

Run `npx skills add onyx-dot-app/onyx --skill onyx-cli -a claude-code`. Or copy the skill folder (cli/internal/embedded in onyx-dot-app/onyx) into .claude/skills/onyx-cli in your project. Claude Code loads it when a task matches its description.

How do I install Onyx CLI in Codex?

Run `npx skills add onyx-dot-app/onyx --skill onyx-cli -a codex`. Or copy the skill folder (cli/internal/embedded in onyx-dot-app/onyx) into .agents/skills/onyx-cli in your project. Codex loads it when a task matches its description.

Can I use Onyx CLI in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add onyx-dot-app/onyx --skill onyx-cli -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/onyx-cli, .gemini/skills/onyx-cli, .github/skills/onyx-cli and .opencode/skills/onyx-cli in your project.

What does Onyx CLI need to run?

Going by SKILL.md and its folder, Onyx CLI needs Go for the scripts in its folder and the command-line tools its instructions call (jq and pip). Our summary lists: Python 3.

Does Onyx CLI access the network?

SKILL.md names 1 domain. In commands or code: cloud.onyx.app; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Onyx CLI safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Onyx CLI use?

Onyx CLI has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Onyx CLI use?

About 2.6k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Onyx CLI?

Skills that share tags, products or a category with Onyx CLI: Capture Conversation (outline/outline, 41k stars), Project Cairn (iBlinkQ/project-cairn, 235 stars), LLM Wiki Knowledge Graph (Egonex-AI/Understand-Anything, 86k stars) and Find And Cite (outline/outline, 41k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Onyx CLI?

onyx-dot-app (a GitHub organization) maintains it in onyx-dot-app/onyx, which has 32,352 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on October 8, 2026.

Source: onyx-dot-app/onyx on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.