Package Exports

@agentoctopus/cli/dist/index.js
@agentoctopus/cli/dist/onboard.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@agentoctopus/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@agentoctopus/cli

Command-line interface for AgentOctopus — route natural language queries to skills from your terminal.

Install

npm install -g @agentoctopus/cli

Usage

Ask a question

octopus ask "translate hello to French"
# → Bonjour

octopus ask "what's the weather in Tokyo?"
# → Tokyo: ⛅ Partly cloudy, 18°C, Humidity: 72%, Wind: 14km/h

octopus ask "look up 8.8.8.8"
# → IP: 8.8.8.8 | Google LLC | US, United States

After each answer, you'll be prompted for feedback (y/n) which is used to rank skills over time.

List available skills

octopus list
# NAME         DESCRIPTION                          RATING  USES
# translation  Translate text between languages     4.8     12
# weather      Get current weather for any city     4.5     7
# ip-lookup    Look up IP address or domain info    4.0     3

Configuration

Create a .env file in your working directory (or set environment variables):

LLM_PROVIDER=openai          # openai | gemini | ollama
LLM_MODEL=gpt-4o-mini
OPENAI_API_KEY=sk-...
OPENAI_BASE_URL=             # optional, for compatible endpoints

EMBED_PROVIDER=openai
EMBED_MODEL=text-embedding-3-small
EMBED_API_KEY=
EMBED_BASE_URL=

REGISTRY_PATH=./registry/skills     # path to your skill manifests
RATINGS_PATH=./registry/ratings.json

Adding custom skills

From ClaWHub (recommended)

Browse skills at clawhub.ai and install with one command:

# Search for skills
octopus search "self-improving"

# Install a skill
octopus add self-improving-agent

# Install a specific version
octopus add self-improving-agent --version 3.0.6

# Remove a skill
octopus remove self-improving-agent

Manual

Point REGISTRY_PATH at a folder of SKILL.md files:

---
name: my-skill
description: What this skill does and when to use it.
tags: [tag1, tag2]
version: 1.0.0
endpoint: https://api.example.com/invoke
adapter: http
---

## Instructions

Detailed instructions for the LLM on how/when to invoke this skill.

See @agentoctopus/registry for the full skill manifest format.

License

Apache 2.0