Quickstart

August 10, 2026 · View on GitHub

Install Uni-CLI, search for the result you want, then run the selected operation.

1. Install

npm install -g @zenalexa/unicli

Confirm the version.

unicli --version

Check for future releases without installing anything.

unicli upgrade --check -f json

2. Search by intent

unicli search "top Hacker News stories"

Uni-CLI ranks matching operations and shows the command, interface, effect, and target surface.

Search results also include the exact invocation, inspection command, authentication state, and setup command when login is required.

3. Plan from one goal

Use do when an agent needs the selected operation, argument schema, and next action in one response.

unicli do "show my saved Xiaohongshu notes" -f json

do plans the call. The agent reviews the selected effect and arguments, then runs the returned next_action.

4. Inspect the match

unicli describe hackernews top

describe shows the accepted arguments and an example invocation. It is the fastest way to prepare a reliable agent call.

5. Run the operation

unicli hackernews top --limit 5 -f json

A successful call returns a v2 envelope.

{
  "ok": true,
  "schema_version": "2",
  "command": "hackernews.top",
  "data": [{ "rank": "1", "title": "...", "url": "https://..." }],
  "error": null
}

Use Uni-CLI from an agent

Paste this into an agent that can run shell commands.

Install Uni-CLI with npm install -g @zenalexa/unicli.
Before using a website, app, or local tool, run unicli search "<intent>" or unicli do "<goal>".
Inspect the selected command with unicli describe <site> <command>, then run it with -f json.
When meta.update appears, run its unattended_command and retry the original task.
If authentication is required, follow the suggestion in the error envelope.

For MCP, Claude Desktop, Cursor, Codex, and other clients, continue to Connect an agent.

Find personal and account data

Personalized operations cover the signed-in user's feed, saved library, network, account, and activity surfaces. Filter the catalog when the intent contains terms such as my, saved, following, or recommendations.

unicli list --personalized
unicli list --site xiaohongshu --personalized
unicli search "my saved Xiaohongshu notes" --personalized
unicli describe xiaohongshu saved
unicli xiaohongshu saved --limit 20 -f json

The operation catalog has matching Personalized and Auth required filters. Expand a site to inspect every registered command.

The error envelope names the next command. A typical setup follows.

unicli auth setup <site>
unicli auth import <site> --browser chrome
unicli auth check <site>

Browser-backed operations use Uni-CLI browser profiles and sessions. See Authentication and Browser and desktop.

When an operation breaks

Read the error first. Adapter failures can include the source file, failed step, and a repair command.

unicli repair <site> <command> --dry-run
unicli repair <site> <command>

See Self-repair for the complete workflow.