@iruidong/code 0.1.0

package/QUICKSTART.md

@@ -0,0 +1,119 @@
+# Ruidong Code Quick Start
+
+## 1. Install
+
+```bash
+npm install -g @iruidong/code
+ruidong --version
+```
+
+Expected output:
+
+```bash
+Ruidong Code v0.1.0
+```
+
+## 2. Prepare your key
+
+Ruidong Code can store a direct secret in config, but the recommended path is an environment variable:
+
+```bash
+export RUIDONG_API_KEY="your_api_key"
+```
+
+## 3. Initialize provider config
+
+### Option A: Wizard
+
+```bash
+ruidong init
+```
+
+Use this if you want Ruidong Code to guide you through endpoint, key env name, and model selection.
+
+### Option B: Preset profile
+
+`iruidong`:
+
+```bash
+ruidong init --force --profile iruidong
+```
+
+`crs`:
+
+```bash
+ruidong init --force --profile crs
+```
+
+### Option C: Custom gateway
+
+```bash
+ruidong init --force \
+  --provider anthropic-compatible \
+  --base-url https://your-gateway.example/v1 \
+  --key-env RUIDONG_API_KEY \
+  --model qwen
+```
+
+If you do not know the model ID yet, omit `--model`. After startup you can choose one with `/model`.
+
+## 4. Verify headless mode
+
+```bash
+ruidong -p "你好，请只回复 OK" --bare
+```
+
+If your config already contains a default model, this should return a short response immediately.
+
+If your gateway requires an explicit model:
+
+```bash
+ruidong -p "你好，请只回复 OK" --bare --model glm
+```
+
+## 5. Start an interactive session
+
+```bash
+cd /path/to/project
+ruidong
+```
+
+Useful first commands:
+
+```text
+/model
+/init
+/mcp
+/plugin
+```
+
+## 6. Project instruction files
+
+Ruidong Code uses:
+
+- `Ruidong.md` for shared repository instructions
+- `Ruidong.local.md` for local private instructions
+
+Legacy `CLAUDE.md` names are still supported for compatibility.
+
+## 7. Common troubleshooting
+
+Auth errors:
+
+```bash
+echo $RUIDONG_API_KEY
+cat ~/.ruidong-code/config.json
+ruidong doctor
+```
+
+Need to rebuild config:
+
+```bash
+ruidong init --force
+```
+
+Need more debug output:
+
+```bash
+ruidong -p "test" --bare --debug-to-stderr
+```

package/README.md

@@ -0,0 +1,127 @@
+# Ruidong Code
+
+Ruidong Code is a terminal coding assistant CLI that works with Anthropic-compatible gateways and relay services. You can point it at your own API URL, choose a default model, and keep runtime settings in `~/.ruidong-code/config.json`.
+
+## Install
+
+```bash
+npm install -g @iruidong/code
+ruidong --version
+```
+
+Node.js `>=18` is required.
+
+## Quick Start
+
+### 1. Set your API key
+
+```bash
+export RUIDONG_API_KEY="your_api_key"
+```
+
+### 2. Initialize config
+
+Interactive wizard:
+
+```bash
+ruidong init
+```
+
+Preset profiles:
+
+```bash
+ruidong init --force --profile iruidong
+ruidong init --force --profile crs
+```
+
+Custom gateway:
+
+```bash
+ruidong init --force \
+  --provider anthropic-compatible \
+  --base-url https://your-gateway.example/v1 \
+  --key-env RUIDONG_API_KEY
+```
+
+### 3. Start using it
+
+Interactive session:
+
+```bash
+cd /path/to/project
+ruidong
+```
+
+Non-interactive check:
+
+```bash
+ruidong -p "你好，请只回复 OK" --bare
+```
+
+## Config Model
+
+Ruidong Code stores runtime config in:
+
+```bash
+~/.ruidong-code/config.json
+```
+
+Common provider fields:
+
+```json
+{
+  "provider": {
+    "id": "anthropic-compatible",
+    "baseUrl": "https://your-gateway.example/v1",
+    "authToken": "env:RUIDONG_API_KEY",
+    "authMode": "auto",
+    "defaultModel": "glm"
+  }
+}
+```
+
+Supported init flows:
+
+- `iruidong`: built-in preset for `https://iruidong.com`
+- `crs`: built-in preset for the CRS relay profile
+- `anthropic-compatible`: generic gateway mode
+
+## Instruction Files
+
+Project instruction files now use:
+
+- `Ruidong.md`: shared project instructions
+- `Ruidong.local.md`: local private instructions
+
+Legacy `CLAUDE.md` and `CLAUDE.local.md` are still read for compatibility.
+
+## Useful Commands
+
+```bash
+ruidong --help
+ruidong init --help
+ruidong -p "summarize this repo" --bare
+ruidong doctor
+```
+
+Inside an interactive session:
+
+- `/model`
+- `/init`
+- `/mcp`
+- `/plugin`
+
+## Docs
+
+- [Quick Start](./QUICKSTART.md)
+- [双平台配置说明](./docs/PLATFORM_SPLIT_CN.md)
+
+## Release Verification
+
+Before publishing:
+
+```bash
+npm run build
+npm run verify:p0
+npm pack
+```