CLI overview

The lookio command is a thin layer over the REST API. It runs on your machine or in your CI, holds no secret of Lookio’s, and prints JSON automatically whenever its output is not a terminal. It requires Node.js 20 or newer.

Install

The package is @lookio/cli on npm. It needs Node.js 20 or later. Setting Lookio up from an AI agent? See Connect an AI agent.

npm install --global @lookio/cli
lookio --help

Or run it without installing:

npx @lookio/cli account

The binary is called lookio. The lookio-cli package that is already on npm is the previous generation: it talks to the previous API and has different commands. Do not use it for these pages.

Sign in and check the connection

lookio auth login        # opens your browser and stores a token in your OS keychain
lookio account           # the workspace, the plan, the credit balance and what this credential may do
lookio doctor            # connectivity, credential, CLI version and clock skew

For a CI job, use an API key instead of a browser: see Authentication.

Your first questions

lookio resources add-url https://example.com/pricing --tags pricing
lookio resources get RESOURCE_ID          # repeat until status is ready or failed

lookio assistants create --name "Support" --follow-tags pricing
lookio ask ASSISTANT_ID "How much does the Pro plan cost?"

Imports do not wait

resources add-text, add-url, add-file, sites add and resources reindex return at once with a resource in queued. Lookio reads it in the background. Poll lookio resources get until status is ready or failed. Both are final.

Global flags

You can write these before or after the subcommand.

Where to go next

• Authentication: browser, device and API key sign-in, profiles and where credentials are stored.
• Commands: every command.
• Automation: JSON output, polling, retries and CI.
• Exit codes, including 7 for out of credits.