Skip to content
Merged
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
87 changes: 87 additions & 0 deletions docs/integrations/claude-code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
id: claude-code
title: Claude Code
sidebar_position: 10
description: List and run Maxun robots directly from your terminal using the Claude Code skill.
---

# Claude Code

The Maxun skill for <a href="https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview" target="_blank">Claude Code</a> lets you list, run, and retrieve results from your Maxun robots directly inside your terminal workflow.

---

## Prerequisites

- <a href="https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview" target="_blank">Claude Code</a> installed
- A Maxun Cloud account at <a href="https://app.maxun.dev" target="_blank">app.maxun.dev</a> or a self-hosted instance
- API Key from <a href="/api/api">Maxun Dashboard</a>

---

## Setup

### 1. Identify your working directory

Claude Code keeps its config file recursively up from the directory where you run the tool. For instance, you could use `~/.claude/skills/maxun`.

### 2. Download the skill files

```bash
# 1. Create the skill directory
mkdir -p ~/.claude/skills/maxun/scripts

# 2. Download the skill files
curl -sf -o ~/.claude/skills/maxun/SKILL.md \
https://raw.githubusercontent.com/getmaxun/maxun-skills/main/claude-code/.claude/skills/maxun/SKILL.md
curl -sf -o ~/.claude/skills/maxun/scripts/maxun.sh \
https://raw.githubusercontent.com/getmaxun/maxun-skills/main/claude-code/.claude/skills/maxun/scripts/maxun.sh

# 3. Make the script executable
chmod +x ~/.claude/skills/maxun/scripts/maxun.sh
```

### 3. Configure your API key

The skill automatically looks for a `.env` file in your **project root** and loads the variables without any extra configuration needed inside Claude Code.

Just add to your project's `.env`:
```bash
MAXUN_API_KEY="your_api_key_here"
```

For **self-hosted Maxun** users, also set your base URL in the same `.env` file:
```bash
MAXUN_BASE_URL="http://localhost:8080"
```

*(Alternatively, you can export these variables directly in your bash or zsh profiles if you prefer them to be globally injected without a `.env` file).*

---

## Usage

Once installed, your agent will automatically understand requests about your robots directly in your command line:

- "What Maxun robots do I have?"
- "Run my product scraper robot"
- "Show me the result for the last run of robot abc123"
- "Abort run run_xyz789 for robot abc123"

### Available Commands (Slash Commands)

| Command / Prompt | Action |
| --- | --- |
| `/maxun list` | List all robots |
| `/maxun run <robotId>` | Run a robot (synchronous) |
| `/maxun result <robotId> <runId>` | Fetch a specific run result |
| `/maxun runs <robotId>` | List all past runs for a robot |
| `/maxun get <robotId>` | Get detailed robot metadata |
| `/maxun abort <robotId> <runId>` | Stop an in-progress execution |

---

## Resources

- <a href="https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/overview" target="_blank">Claude Code</a>
- <a href="https://github.com/getmaxun/maxun-skills" target="_blank">Maxun Skills Repository</a>
32 changes: 11 additions & 21 deletions docs/integrations/openclaw.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ The skill is published on <a href="https://clawhub.ai/RohitR311/maxun" target="_
## Prerequisites

- OpenClaw running (self-hosted gateway)
- A Maxun Cloud account at <a href="https://app.maxun.dev" target="_blank">app.maxun.dev</a>
- A Maxun API key (generated from **Settings → API Key** in your dashboard)
- The ClawHub CLI installed:
- A Maxun Cloud account at <a href="https://app.maxun.dev" target="_blank">app.maxun.dev</a> or a self-hosted instance
- API Key from <a href="/api/api">Maxun Dashboard</a>
- The ClawHub CLI installed

```bash
npm i -g clawhub
Expand All @@ -38,29 +38,19 @@ This downloads the skill into your `./skills` directory and records it in `.claw

### 2. Configure your API key

Add your Maxun API key to `~/.openclaw/openclaw.json` under the skill's `env` block:

```json
{
"skills": {
"entries": {
"maxun": {
"enabled": true,
"env": {
"MAXUN_API_KEY": "your_api_key_here"
}
}
}
}
}
```
The skill automatically looks for a `.env` file in your OpenClaw gateway directory and loads the variables seamlessly without needing to export them manually. Create or edit a `.env` file in the root of your OpenClaw deployment:

Or run the command
```bash
MAXUN_API_KEY="your_api_key_here"
```

For **self-hosted Maxun** users, also set your base URL in the same `.env` file:
```bash
openclaw config set env.MAXUN_API_KEY "your_api_key_here"
MAXUN_BASE_URL="http://localhost:8080"
```

*(Alternatively, you can configure your API key directly in your OpenClaw `~/.openclaw/openclaw.json` under the skill's `env` block or run `openclaw config set env.MAXUN_API_KEY "your_key"`)*

### 3. Restart the gateway

```bash
Expand Down
6 changes: 6 additions & 0 deletions src/theme/DocSidebarItem/Link/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ import { IoTriangleSharp } from "react-icons/io5";
const OpenClawIcon = ({ style }) => (
<img src="/img/openclaw_icon.png" style={{ width: "1.2em", height: "1.2em", verticalAlign: "middle", objectFit: "contain", filter: "grayscale(1)", ...style }} />
);
const ClaudeIcon = ({ style }) => (
<img src="/img/claude.svg" style={{ width: "1.2em", height: "1.2em", verticalAlign: "middle", objectFit: "contain", filter: "grayscale(1)", ...style }} />
);

const IconMap = {
introBook: HiOutlineBookOpen,
Expand Down Expand Up @@ -101,6 +104,7 @@ const IconMap = {
openai: SiOpenai,
vercel_ai_sdk: IoTriangleSharp,
openclaw: OpenClawIcon,
"claude-code": ClaudeIcon,
search_introduction: MdOutlineInfo,
search_configuration: FiSettings,
stealth: RiRobot2Line,
Expand Down Expand Up @@ -195,6 +199,8 @@ const SidebarIconMap = {
"integrations/vercel-ai-sdk": "vercel_ai_sdk",
openclaw: "openclaw",
"integrations/openclaw": "openclaw",
"claude-code": "claude-code",
"integrations/claude-code": "claude-code",
// DEVELOPMENT
i18n: "i18n",
"/development/i18n": "i18n",
Expand Down
1 change: 1 addition & 0 deletions static/img/claude.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.