@ai-setting/roy-agent-cli 1.0.0

package/README.md

@@ -0,0 +1,126 @@
+# @gddzhaokun/roy-agent-cli
+
+Command-line interface for roy-agent. Provides non-interactive command execution.
+
+## Dependencies
+
+- `@gddzhaokun/roy-agent-core` ^1.1.0 - Core SDK
+- `chalk` ^5.3.0 - Terminal colors
+- `yargs` ^17.7.2 - CLI argument parsing
+- `zod-to-json-schema` ^3.25.2 - Zod to JSON Schema conversion
+
+## Build
+
+### Prerequisites
+
+**Important**: Build `@gddzhaokun/roy-agent-core` first before building CLI.
+
+```bash
+# 1. Build core first
+cd packages/core
+bun run build:core:prod:single --pack --check
+npm publish --access public --registry=https://npm.pkg.github.com/
+
+# 2. Then build CLI
+cd ../cli
+bun run build:cli:prod:single --pack --check
+```
+
+### Build Modes
+
+| Mode | Command | Output | Description |
+|------|---------|--------|-------------|
+| Dev Single | `bun run build:cli:dev:single` | `roy.js` | Current platform, with sourcemap |
+| Dev All | `bun run build:cli:dev` | `roy.js` | All platforms, with sourcemap |
+| Prod Single | `bun run build:cli:prod:single` | `roy` | Current platform, standalone exe |
+| Prod All | `bun run build:cli:prod` | `roy` | All platforms, standalone exe |
+
+### Build Options
+
+| Flag | Description |
+|------|-------------|
+| `--single` | Build for current platform only |
+| `--pack` | Create npm tarball after build |
+| `--publish` | Pack and publish to npm |
+| `--check` | Verify tarball contents |
+
+### Build Steps (Production Mode)
+
+1. **Build JS library** - Uses `tsc` to compile TypeScript
+2. **Fix ESM imports** - Adds `.js` extensions for Node.js compatibility
+3. **Bundle** - Uses `bun build` to create bundle
+4. **Compile** - Uses `bun compile` to create standalone executable
+
+## Development
+
+Run from source without building:
+
+```bash
+bun run dev
+# or
+bun run src/bin/roy.ts
+```
+
+## Usage
+
+```bash
+# Interactive mode
+roy
+
+# Execute task
+roy act "帮我写一个 hello world"
+
+# With options
+roy act "任务" --model gpt-4 --quiet
+```
+
+## Publishing
+
+```bash
+# Build and pack
+bun run build:cli:prod:single --pack --check
+
+# Publish to GitHub Packages
+npm publish --access public --registry=https://npm.pkg.github.com/
+```
+
+### Version
+
+Current: **1.2.8**
+
+To publish a new version:
+
+```bash
+# 1. Update version in package.json
+vi package.json
+
+# 2. Build and pack
+bun run build:cli:prod:single --pack --check
+
+# 3. Verify tarball
+tar -tzf gddzhaokun-roy-agent-cli-*.tgz | head -20
+
+# 4. Publish
+npm publish --access public --registry=https://npm.pkg.github.com/
+```
+
+## Troubleshooting
+
+### Type errors when building
+
+Ensure `@gddzhaokun/roy-agent-core` is built and published first:
+
+```bash
+cd packages/core
+bun run build:core:prod:single
+npm publish --access public --registry=https://npm.pkg.github.com/
+```
+
+### CLI commands not working after install
+
+Reinstall dependencies:
+
+```bash
+rm -rf node_modules
+bun install
+```