docs(cli): Add README for examples/cli-config
Browse files
examples/cli-config/README.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# CLI Configuration Examples
|
| 2 |
+
|
| 3 |
+
This directory contains helper scripts and example configurations for routing third-party CLI tools through **CLIProxyAPI Plus**.
|
| 4 |
+
|
| 5 |
+
## Contents
|
| 6 |
+
|
| 7 |
+
- `setup_env.sh`: A simple template for exporting environment variables.
|
| 8 |
+
- `proxy-tools.rc`: A shell resource file containing convenient functions (`p-claude`, `p-code`) for scoped proxy routing.
|
| 9 |
+
|
| 10 |
+
## Getting Started (The Easy Way)
|
| 11 |
+
|
| 12 |
+
1. Open your `~/.bashrc` or `~/.zshrc` file.
|
| 13 |
+
2. Add the following line to the end of the file:
|
| 14 |
+
```bash
|
| 15 |
+
source /path/to/CLIProxyAPIPlus/examples/cli-config/proxy-tools.rc
|
| 16 |
+
```
|
| 17 |
+
3. Restart your terminal or run `source ~/.zshrc`.
|
| 18 |
+
4. Run your tools with the `p-` prefix:
|
| 19 |
+
* `p-claude`
|
| 20 |
+
* `p-code`
|
| 21 |
+
|
| 22 |
+
For detailed integration instructions, see the main [CLI Integration Guide](../../docs/CLI_INTEGRATION.md).
|