@rayu-dev/rayu-cli 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/dist/rayu.js +733380 -0
- package/package.json +115 -0
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Rayu-CLI Documentation
|
|
2
|
+
|
|
3
|
+
Rayu-CLI is a terminal-based AI coding agent. It is a self-branded, multi-provider
|
|
4
|
+
fork of the Claude Code CLI that lets you **bring your own API key** and use
|
|
5
|
+
**any OpenAI-compatible provider** (NVIDIA, DeepSeek, Kimi/Moonshot, Doubleword,
|
|
6
|
+
OpenAI, OpenRouter, local servers) as well as Anthropic — with free model
|
|
7
|
+
switching, MCP support, and the full built-in tool suite.
|
|
8
|
+
|
|
9
|
+
> Educational/research. Not affiliated with or endorsed.
|
|
10
|
+
|
|
11
|
+
## Documentation map
|
|
12
|
+
|
|
13
|
+
| # | Document | What's inside |
|
|
14
|
+
|---|----------|---------------|
|
|
15
|
+
| 1 | [Installation](./01-installation.md) | Requirements, build, the `rayu` binary |
|
|
16
|
+
| 2 | [Quickstart](./02-quickstart.md) | First run, your first conversation |
|
|
17
|
+
| 3 | [Providers](./03-providers.md) | Connecting providers, `/connect`, API keys, `.env` import |
|
|
18
|
+
| 4 | [Models](./04-models.md) | Searchable `/model` picker, context windows |
|
|
19
|
+
| 5 | [Configuration](./05-configuration.md) | Config directories, files, all environment variables |
|
|
20
|
+
| 6 | [CLI Reference](./06-cli-reference.md) | Commands, flags, interactive vs print mode |
|
|
21
|
+
| 7 | [Slash Commands](./07-slash-commands.md) | In-session commands (`/connect`, `/model`, …) |
|
|
22
|
+
| 8 | [MCP](./08-mcp.md) | Model Context Protocol server management |
|
|
23
|
+
| 9 | [Diagnostics & Privacy](./09-diagnostics-privacy.md) | Bug/issue logging, telemetry, network posture |
|
|
24
|
+
| 10 | [Troubleshooting](./10-troubleshooting.md) | Common errors and fixes |
|
|
25
|
+
| 11 | [Codebase Knowledge Graph](./11-knowledge-graph.md) | Explore the codebase with `graphify` — query symbols, find paths, understand architecture | |
|
|
26
|
+
|
|
27
|
+
## 30-second tour
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# build
|
|
31
|
+
cd claude-code && export PATH="$HOME/.bun/bin:$PATH"
|
|
32
|
+
bun install && bun run build
|
|
33
|
+
|
|
34
|
+
# run (interactive) — on first launch, pick a provider + paste your API key
|
|
35
|
+
node dist/rayu.js
|
|
36
|
+
|
|
37
|
+
# or headless, against NVIDIA
|
|
38
|
+
RAYU_OPENAI_COMPATIBLE=1 \
|
|
39
|
+
RAYU_OPENAI_BASE_URL=https://integrate.api.nvidia.com/v1 \
|
|
40
|
+
RAYU_OPENAI_API_KEY=nvapi-xxxxx \
|
|
41
|
+
node dist/rayu.js --print --model meta/llama-3.3-70b-instruct "summarize this repo"
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
In a session:
|
|
45
|
+
- `/connect` — add a provider (pick type → enter key → choose a model)
|
|
46
|
+
- `/model` — searchable model picker across all connected providers
|
|
47
|
+
- `/help` — list all slash commands
|
|
48
|
+
|
|
49
|
+
## Key concepts
|
|
50
|
+
|
|
51
|
+
- **Provider** — an API endpoint + key. Two kinds: `anthropic` (Anthropic API)
|
|
52
|
+
and `openai-compatible` (everything else, via an OpenAI ↔ Anthropic translation layer).
|
|
53
|
+
- **Config home** — `~/.rayu` by default; an existing `~/.claude` (Claude Code)
|
|
54
|
+
is used automatically if `~/.rayu` is absent. See [Configuration](./05-configuration.md).
|
|
55
|
+
- **Diagnostics** — runtime bugs/issues/vulnerabilities are logged to
|
|
56
|
+
`~/.rayu/diagnostics.jsonl`. See [Diagnostics](./09-diagnostics-privacy.md).
|