artbot
v0.4.0
Published
CLI for running ArtBot market research locally.
Maintainers
Readme
artbot
Local-first CLI for ArtBot art-market research, source discovery, evidence capture, and valuation support.
Install
npm install -g artbot
artbot --helpFor a one-off check:
npx artbot@latest --helpThe npm package includes the CLI plus bundled local API and worker runtime. No hosted ArtBot service is required. Local state is stored under ~/.artbot by default.
Requirements
- Node.js 22+
- An OpenAI-compatible model endpoint for model-backed extraction/setup paths
- Playwright Chromium for auth capture and browser verification flows
Fast Start
artbot backend start
artbot backend status
artbot research artist --artist "Burhan Dogancay" --preview-only
artbot research artist --artist "Burhan Dogancay" --waitOptional guided onboarding:
artbot setupartbot setup can configure local LM Studio, NVIDIA, or another OpenAI-compatible endpoint. Plan generation can take 45-60 seconds on a cold start.
Commands
Bare artbot opens the interactive TUI in an interactive terminal. Use explicit subcommands for automation.
# Backend and health
artbot doctor
artbot backend start
artbot backend status
artbot backend stop
# Research
artbot research artist --artist "Fikret Mualla" --preview-only
artbot research artist --artist "Fikret Mualla" --wait
artbot research work --artist "Bedri Rahmi Eyuboglu" --title "Mosaic" --wait
# Runs and reports
artbot runs list --limit 20
artbot runs show --run-id <id>
artbot runs watch --run-id <id> --interval 2
artbot runs deep-research --run-id <id>
artbot runs deep-research --run-id <id> --web
# Storage
artbot runs pin --run-id <id>
artbot runs unpin --run-id <id>
artbot storage
artbot cleanup --dry-run
# Debug/review
artbot replay attempt --run-id <id>
artbot review queue --run-id <id>
artbot graph explain --run-id <id> --cluster-id <cluster-id>
artbot canaries runGlobal machine-output options:
artbot --json runs list
artbot --output-format stream-json runs watch --run-id <id>Set ARTBOT_NO_TUI=1 or pass --no-tui when an automation wrapper must not open interactive prompts.
Custom Source Websites
Add operator-controlled websites to artbot.sources.json:
artbot sources list --json
artbot sources validate
artbot sources add \
--name "Example Auction Archive" \
--url "https://example.com" \
--search-template "https://example.com/search?q={query}" \
--access public \
--source-class auction_house
artbot sources remove --id example-auction-archiveConfig path resolution:
ARTBOT_SOURCES_PATHARTBOT_HOME/artbot.sources.jsonINIT_CWD/artbot.sources.json./artbot.sources.json
Supported access modes:
public: anonymous public access first.auth: source remains visible asauth_requireduntil a matching session exists.licensed: requires--allow-licensedand matching--licensed-integrations.
Example:
{
"version": 1,
"sources": [
{
"id": "member-price-db",
"name": "Member Price DB",
"url": "https://member.example",
"searchTemplate": "https://member.example/search?q={query}",
"access": "auth",
"sourceClass": "database",
"authProfileId": "member-db"
}
]
}Do not store passwords or API secrets in artbot.sources.json.
Auth Capture
Configure auth profiles with AUTH_PROFILES_JSON, then capture browser storage state:
artbot trust allow
artbot auth list
artbot auth status
artbot auth capture member-db --url https://member.example/loginResearch flags:
artbot research artist \
--artist "Burhan Dogancay" \
--auth-profile member-db \
--allow-licensed \
--licensed-integrations "Sanatfiyat" \
--waitInteractive setup, TUI launch, auth capture, and backend start/stop require workspace trust:
artbot trust status
artbot trust allow
artbot trust denyLocal State
By default, ArtBot stores runtime state under:
~/.artbotExpected contents include:
.envdata/artbot.dbruns/logs/playwright/.auth/artbot.sources.jsonwhen custom sources are configured underARTBOT_HOME
Models
Core setup supports local LM Studio, NVIDIA, and custom OpenAI-compatible endpoints through:
LLM_BASE_URLLLM_API_KEYLLM_MODELSTRUCTURED_LLM_PROVIDERSTAGEHAND_MODE
Experimental Gemini Deep Research is opt-in from the TUI. It runs after normal research, writes deep-research.json, and can be inspected with:
artbot runs deep-research --run-id <id>
artbot runs deep-research --run-id <id> --webThis feature is cloud-based and can be expensive. Set a Google AI Studio spend cap before heavy use.
Responsible Use
Use only public, credentialed, or licensed access that you are authorized to use. Do not use ArtBot for credential stuffing, CAPTCHA evasion, paywall bypass, or other access-control circumvention.
Links
- Repository: https://github.com/KhazP/artbot
- npm: https://www.npmjs.com/package/artbot
- License: Apache-2.0
