Skip to content

Latest commit

 

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 

Repository files navigation

Maxun Skills

A collection of skills to integrate Maxun (the open-source web scraping platform) with popular agentic coding tools like Claude Code and OpenClaw (ClawHub).

These skills allow your AI agent to list, run, and fetch results from your Maxun robots directly from your terminal or messaging apps.


📂 Repository Structure


🛠️ Installation

1. Claude Code

To add the Maxun skill to Claude Code, run these commands:

# 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

2. OpenClaw (ClawHub)

The Maxun skill for OpenClaw is published on ClawHub.

Automatically via ClawHub CLI:

# Install the ClawHub CLI
npm i -g clawhub

# Install the Maxun skill
clawhub install maxun

Manually:

If you prefer to install manually from this repository:

  1. Create a directory: ~/.openclaw/workspace/skills/maxun
  2. Copy the contents of the openclaw/ folder from this repo into that directory.
  3. Ensure scripts/maxun.sh is executable: chmod +x ~/.openclaw/workspace/skills/maxun/scripts/maxun.sh

Configuration

Both skills require your Maxun API Key (get yours at: https://app.maxun.dev/apikey). They are fully compatible with both Maxun Cloud accounts and self-hosted Open Source installations.

The easiest way to configure both Claude Code and OpenClaw is to create a .env file in your current working directory (for Claude Code) or in the root of your OpenClaw deployment. The skills will automatically load variables from this file, meaning you do not need to export them manually.

MAXUN_API_KEY="your_api_key_here"

For Self-Hosted Users

If you are running Maxun locally or on your own server, also add MAXUN_BASE_URL to your .env file:

MAXUN_BASE_URL="http://localhost:8080"

Default: https://app.maxun.dev

(Note for OpenClaw: You can alternatively configure your API key directly in ~/.openclaw/openclaw.json or by running openclaw config set env.MAXUN_API_KEY "your_key" and restarting the gateway).


🤖 Usage

Once installed, your agent (Claude or OpenClaw) will automatically understand requests about your robots:

  • "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 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

⚠️ Compatibility

  • Claude Code: Supports app.maxun.dev and self-hosted instances.
  • OpenClaw: Supports both cloud and self-hosted via MAXUN_BASE_URL.

About

Maxun skills for different AI agentic platforms

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages