Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions docs/other_cli/claude_code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Claude Code

!!! danger "Third-Party Scaffolding — Privacy & Security Warning"
Third-party scaffoldings may be serving your data outside your environment.
For **privacy** and **cybersecurity refusal optimization**, use **CAI** to obtain the best performance.

!!! warning "Support Disclaimer"
Alias Robotics **does not provide support** for developments or integrations related to Claude Code. This page documents API compatibility only. Alias simply allows usage of the Alias API through your preferred scaffolding.

---

## Step 1: Install Claude Code

### Prerequisites

- **Node.js 18** or newer
- For **macOS**, use [nvm](https://github.com/nvm-sh/nvm) to install Node.js — installing the package directly may cause permission issues
- For **Windows**, additionally install [Git for Windows](https://gitforwindows.org/)

```bash
# Install Claude Code
npm install -g @anthropic-ai/claude-code

# Navigate to your project
cd your-awesome-project

# Launch
claude
```

!!! note
If macOS users encounter permission issues during installation, use `nvm` to install Node.js.

---

## Step 2: Configure the Alias API

### 1. Get your Alias API Key

An `ALIAS_API_KEY` (format: `sk-...`) can be obtained from either of the following:

- **[CAI PRO](https://aliasrobotics.com/cybersecurityai.php)** — full cybersecurity AI platform with access to `alias1` and other models.
- **[Alias LLMs](https://aliasrobotics.com/aliasLLMs.php)** — acquire `alias2-mini` and other Alias language models directly.

### 2. Configure Environment Variables

Set up environment variables using one of the following methods for macOS/Linux or Windows.

!!! note
Some commands show no output when setting environment variables — that's normal as long as no errors appear. A new terminal window may be required for the changes to take effect.

#### macOS & Linux

Edit the Claude Code configuration file `~/.claude/settings.json`. Add or modify the `env` fields `ANTHROPIC_BASE_URL` and `ANTHROPIC_AUTH_TOKEN`.

Replace `your_alias_api_key` with the API Key you obtained in the previous step.

```json
{
"env": {
"ANTHROPIC_AUTH_TOKEN": "your_alias_api_key",
"ANTHROPIC_BASE_URL": "https://api.aliasrobotics.com:666/",
"API_TIMEOUT_MS": "3000000"
}
}
```

#### Windows Cmd

Run the following commands in Cmd. Replace `your_alias_api_key` with the API Key you obtained in the previous step.

```cmd
setx ANTHROPIC_AUTH_TOKEN your_alias_api_key
setx ANTHROPIC_BASE_URL https://api.aliasrobotics.com:666/
```

#### Windows PowerShell

Run the following commands in PowerShell. Replace `your_alias_api_key` with the API Key you obtained in the previous step.

```powershell
[System.Environment]::SetEnvironmentVariable('ANTHROPIC_AUTH_TOKEN', 'your_alias_api_key', 'User')
[System.Environment]::SetEnvironmentVariable('ANTHROPIC_BASE_URL', 'https://api.aliasrobotics.com:666/', 'User')
```

---

## Step 3: Start with Claude Code

Once the configuration is complete, start using Claude Code in your terminal:

```bash
cd your-project-directory
claude
```

Token usage and billing will appear in your Alias account.

---

## Related

- [CAI PRO Quickstart](../cai_pro_quickstart.md)
- [Available Models](../cai_list_of_models.md)
- [Environment Variables](../environment_variables.md)
72 changes: 72 additions & 0 deletions docs/other_cli/codex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Codex CLI

!!! danger "Third-Party Scaffolding — Privacy & Security Warning"
Third-party scaffoldings may be serving your data outside your environment.
For **privacy** and **cybersecurity refusal optimization**, use **CAI** to obtain the best performance.

[Codex CLI](https://github.com/openai/codex) is OpenAI's open-source terminal-based AI coding agent. Because it uses the **OpenAI API format** natively, it can connect directly to the Alias API without any proxy.

!!! warning "Support Disclaimer"
Alias Robotics **does not provide support** for developments or integrations related to Codex CLI. This page documents API compatibility only. Alias simply allows usage of the Alias API through your preferred scaffolding.

---

## Setup

### 1. Get your Alias API Key

An `ALIAS_API_KEY` (format: `sk-...`) can be obtained from either of the following:

- **[CAI PRO](https://aliasrobotics.com/cybersecurityai.php)** — full cybersecurity AI platform with access to `alias1` and other models.
- **[Alias LLMs](https://aliasrobotics.com/aliasLLMs.php)** — acquire `alias2-mini` and other Alias language models directly.

### 2. Install Codex CLI

```bash
npm install -g @openai/codex
```

### 3. Configure environment variables

```bash
export OPENAI_API_KEY="sk-your-alias-api-key-here"
export OPENAI_BASE_URL="https://api.aliasrobotics.com:666/"
```

To persist these, add them to your shell profile (`~/.zshrc`, `~/.bashrc`, etc.):

```bash
echo 'export OPENAI_API_KEY="sk-your-alias-api-key-here"' >> ~/.zshrc
echo 'export OPENAI_BASE_URL="https://api.aliasrobotics.com:666/"' >> ~/.zshrc
source ~/.zshrc
```

### 4. Run Codex with an Alias model

```bash
codex --model alias1
```

Or set the model inline per session:

```bash
OPENAI_API_KEY="sk-your-alias-api-key-here" \
OPENAI_BASE_URL="https://api.aliasrobotics.com:666/" \
codex --model alias1
```

---

## Notes

- The Alias API is fully OpenAI-compatible — no additional configuration is required beyond pointing the base URL and API key.
- Use `alias1` for best cybersecurity performance, or `alias0` for a faster, lighter alternative.
- Token usage and billing appear in your Alias account dashboard.

---

## Related

- [CAI PRO Quickstart](../cai_pro_quickstart.md)
- [Available Models](../cai_list_of_models.md)
- [Environment Variables](../environment_variables.md)
91 changes: 91 additions & 0 deletions docs/other_cli/opencode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# OpenCode

!!! danger "Third-Party Scaffolding — Privacy & Security Warning"
Third-party scaffoldings may be serving your data outside your environment.
For **privacy** and **cybersecurity refusal optimization**, use **CAI** to obtain the best performance.

[OpenCode](https://opencode.ai) is an open-source, terminal-based AI coding assistant. It supports OpenAI-compatible providers, which means the Alias API can be plugged in directly without any proxy.

!!! warning "Support Disclaimer"
Alias Robotics **does not provide support** for developments or integrations related to OpenCode. This page documents API compatibility only. Alias simply allows usage of the Alias API through your preferred scaffolding.

---

## Setup

### 1. Get your Alias API Key

An `ALIAS_API_KEY` (format: `sk-...`) can be obtained from either of the following:

- **[CAI PRO](https://aliasrobotics.com/cybersecurityai.php)** — full cybersecurity AI platform with access to `alias1` and other models.
- **[Alias LLMs](https://aliasrobotics.com/aliasLLMs.php)** — acquire `alias2-mini` and other Alias language models directly.

### 2. Install OpenCode

```bash
npm install -g opencode-ai
```

Or via Homebrew (macOS):

```bash
brew install sst/tap/opencode
```

### 3. Configure the Alias provider

OpenCode uses a `~/.config/opencode/config.json` file. Add a custom OpenAI-compatible provider pointing to the Alias API:

```json
{
"provider": {
"alias": {
"api": "https://api.aliasrobotics.com:666/",
"name": "Alias Robotics",
"env": ["ALIAS_API_KEY"]
}
},
"model": "alias/alias1"
}
```

Then export your key:

```bash
export ALIAS_API_KEY="sk-your-alias-api-key-here"
```

### 4. Run OpenCode

```bash
opencode
```

OpenCode will pick up the configured provider and route requests to the Alias API.

---

## Alternative: environment variable approach

If you prefer not to edit the config file, OpenCode also respects standard OpenAI environment variables:

```bash
export OPENAI_API_KEY="sk-your-alias-api-key-here"
export OPENAI_BASE_URL="https://api.aliasrobotics.com:666/"
opencode --model alias1
```

---

## Notes

- Use `alias1` for best cybersecurity performance, or `alias0` for a faster, lighter alternative.
- Token usage and billing appear in your Alias account dashboard.

---

## Related

- [CAI PRO Quickstart](../cai_pro_quickstart.md)
- [Available Models](../cai_list_of_models.md)
- [Environment Variables](../environment_variables.md)
8 changes: 8 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ nav:
- Commands Reference: cli/commands_reference.md
- Advanced Usage: cli/advanced_usage.md

# ========================================
# SUPPORTING OTHER CLIs
# ========================================
- Supporting Other CLIs:
- Claude Code: other_cli/claude_code.md
- Codex CLI: other_cli/codex.md
- OpenCode: other_cli/opencode.md

# ========================================
# CORE CONCEPTS
# ========================================
Expand Down