# Alice Research CLI

Looks up symbols, K-line data and workspace conversations via the alice CLI.

- Repository: https://github.com/TraderAlice/OpenAlice (7404 stars)
- Category: Data and ML
- License: AGPL-3.0
- Last updated: 2026-10-24
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add TraderAlice/OpenAlice --skill alice -g -a claude-code -y`
Codex: `npx skills add TraderAlice/OpenAlice --skill alice -g -a codex -y`
Cursor: `npx skills add TraderAlice/OpenAlice --skill alice -g -a cursor -y`
Gemini CLI: `npx skills add TraderAlice/OpenAlice --skill alice -g -a gemini-cli -y`

## Description

Research data and Workspace collaboration through the `alice` CLI: symbol discovery, K-line analysis, optional subscribed-article lookup, peer conversations, Inbox and Issues. Use CLI help for command parameters. Also use alice for Workspace collaboration: peer discovery, Agent conversations, Inbox delivery, Issues, Session identity, tracked assets and template upgrades. Read references/collaboration.md for these workflows.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Research & collaboration, `alice`

`alice` is OpenAlice's research and collaboration interface on your PATH. Output is JSON on stdout
(pipe it: `alice market search --query AAPL | jq '.results[0]'`); a non-zero
exit means it failed, with the reason on stderr.

## Discover, don't guess

```bash
alice --help                       # discover research and collaboration groups
alice <group> <verb> --help        # a verb's flags (which are required)
```

## Workbench research

**Find a symbol** (returns barIds, the operational handle for charts/quant):

```bash
alice market search --query "apple"
```

(Fundamentals, ratios, calendars and macro series live on `traderhub`, e.g. `traderhub equity profile --symbol AAPL`.)

**Expand coverage with vendors.** Symbol search, and the K-line sources it
returns, comes from a set of data vendors; `yfinance` (global, always on) is the
default. For a name a global vendor misses, like a **CN A-share or a Taiwan stock
by its native name**, a local vendor closes the gap. List what's on and what each
covers, then enable one, **live on the next search, no restart**:

```bash
alice market vendors                                    # sources, on/off, and how to use each
alice market vendor-set --vendor twse --enabled true    # Taiwan (TWSE/TPEx); `eastmoney` for CN A-shares
```

If a search for a non-US name comes up empty, check `alice market vendors`
**before giving up**, the covering source may just be off. Each vendor's
`howToUse` flags its quirks (e.g. twse wants 繁体 `台積電`, not 简体 `台积电`).

`alice rss` is an optional quick scan of collected subscription articles,
with limited coverage. Command parameters are available in `alice rss --help`.

**Raw K-lines** use the same BarService as the Market chart. The `market-data`
skill covers source discovery, raw data and chart references in replies:

The rest: https://github.com/TraderAlice/OpenAlice/blob/HEAD/default/skills/alice/SKILL.md