Yavy CLI

Installation

terminal
npm install -g @yavydev/cli

Note: Requires Node.js >= 20

Quick Start

terminal
yavy init

Interactive setup that authenticates, selects projects, and configures your AI tools in one step.

FlagDescription
--tool <name>Configure a specific tool only
--yesNon-interactive mode: all detected tools + all projects

For standalone authentication: yavy login / yavy logout

Search

terminal
yavy search "your query"

Search your indexed documentation directly from the terminal. Results are returned in a readable format optimized for LLM consumption.

FlagDescription
--project <org/project>Scope search to a specific project
--limit <n>Maximum number of results (default: 10)
--jsonOutput as JSON for scripting

Without --project, the search runs across all your indexed projects.

List Projects

terminal
yavy projects
FlagDescription
--jsonOutput as JSON

Generate Skills

terminal
yavy generate <org>/<project>

Generates a Skills package from a project's indexed documentation.

FlagDescription
--global Save to global skills directory (~/.claude/skills/)
--output <path>Custom output path
--forceOverwrite existing skill files
--jsonOutput as JSON

Default output:.claude/skills/<project>/ in the current directory.

Configuration

VariableDescriptionDefault
YAVY_BASE_URLOverride API base URLhttps://yavy.dev
YAVY_CLIENT_IDOverride OAuth client ID(built-in)

CI/CD Example

In CI/CD environments, pre-populate credentials before running CLI commands. Authenticate locally with yavy login, then use the generated skill files committed to your repository. For fresh generation, run yavy generate in your pipeline after authenticating.

github-actions.yml
- name: Generate Yavy Skills
  run: |
    npm install -g @yavydev/cli
    yavy generate my-org/my-project --force

Next Steps