Skip to content

1Panel-dev/1Panel-skills

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

1Panel Skills

English | ็ฎ€ไฝ“ไธญๆ–‡

TypeScript-based 1Panel operations skill for OpenClaw.

Features

  • Resource monitoring: current node metrics, dashboard metrics, top CPU and memory processes, monitor history, GPU history
  • Website inspection: website list and detail, Nginx config reads, domain reads, HTTPS config reads, SSL certificate reads, website log reads
  • Application inspection: app catalog reads, installed app status checks, service reads, port and connection info reads
  • Container inspection: container list, status, inspect, stats, and log reads
  • Log inspection: operation logs, login logs, system log file list, generic log file reads
  • Cronjob inspection: cronjob list and detail, next-run preview, execution records, record log reads
  • Task center inspection: task center records and executing count
  • Node inspection: node list, simple node list, node options, and node status reads
  • Future write operations reserved: module-grouped mutation definitions are already reserved for create, update, delete, restart, and other managed actions

Project Layout

1Panel-skills/
โ”œโ”€โ”€ SKILL.md                  # Skill instructions for OpenClaw
โ”œโ”€โ”€ README.md                 # English README
โ”œโ”€โ”€ README.zh-CN.md           # Chinese README
โ”œโ”€โ”€ openclaw.plugin.json      # Plugin metadata
โ”œโ”€โ”€ plugin.ts                 # OpenClaw plugin entry (TypeScript source)
โ”œโ”€โ”€ package.json              # Node package metadata
โ”œโ”€โ”€ tsconfig.json             # TypeScript typecheck config
โ”œโ”€โ”€ tsconfig.build.json       # TypeScript build config
โ”œโ”€โ”€ agents/
โ”‚   โ””โ”€โ”€ openai.yaml           # UI metadata
โ”œโ”€โ”€ dist/                     # Prebuilt runtime files used by OpenClaw and CLI
โ”‚   โ”œโ”€โ”€ plugin.js
โ”‚   โ””โ”€โ”€ scripts/
โ”‚       โ”œโ”€โ”€ cli.js
โ”‚       โ”œโ”€โ”€ client.js
โ”‚       โ”œโ”€โ”€ index.js
โ”‚       โ””โ”€โ”€ modules/
โ”œโ”€โ”€ references/
โ”‚   โ””โ”€โ”€ module-groups.md      # Module overview and API notes
โ””โ”€โ”€ scripts/
    โ”œโ”€โ”€ cli.ts                # Local CLI entry
    โ”œโ”€โ”€ client.ts             # Signed 1Panel API client
    โ”œโ”€โ”€ index.ts              # Module registry
    โ”œโ”€โ”€ types.ts              # Shared types
    โ””โ”€โ”€ modules/
        โ”œโ”€โ”€ monitoring.ts
        โ”œโ”€โ”€ websites.ts
        โ”œโ”€โ”€ apps.ts
        โ”œโ”€โ”€ containers.ts
        โ”œโ”€โ”€ logs.ts
        โ”œโ”€โ”€ cronjobs.ts
        โ”œโ”€โ”€ task-center.ts
        โ””โ”€โ”€ nodes.ts

Skill Overview

openclaw-1panel

General-purpose 1Panel operations skill for OpenClaw. The current implementation focuses on inspection and status-check interfaces while keeping grouped mutation endpoints reserved for future expansion.

Modules

Module Scope
monitoring Dashboard metrics, current node status, top processes, monitor history, GPU history
websites Website list/detail, config reads, HTTPS reads, certificate reads, website log reads
apps App catalog reads, installed app status checks, service reads, port and connection info
containers Container list, status, inspect, stats, and log reads
logs Operation logs, login logs, system log files, generic log reads
cronjobs Cronjob list/detail, next-run preview, records, record logs, script options
task-center Task center record reads and executing count
nodes Node list, node options, simple list, and node status

Quick Start

1. Requirements

  • Node.js 18 or newer recommended
  • A reachable 1Panel instance
  • A valid 1Panel API key

2. Configure 1Panel API Access

  1. Log in to 1Panel.
  2. Open Settings -> API Interface.
  3. Enable the API interface.
  4. Copy the API key.
  5. Add your client IP or allow all for testing:
    • IPv4: 0.0.0.0/0
    • IPv6: ::/0

1Panel API authentication requires:

  • 1Panel-Timestamp
  • 1Panel-Token = md5("1panel" + API_KEY + TIMESTAMP)

3. Install into OpenClaw

Recommended local install:

mkdir -p ~/.openclaw/skills
ln -s /path/to/1Panel-skills ~/.openclaw/skills/openclaw-1panel

The repository already includes prebuilt runtime files under dist/, so normal use does not require rebuilding before loading the skill.

4. Configure Runtime Variables

export ONEPANEL_BASE_URL="http://192.168.1.2:9999"
export ONEPANEL_API_KEY="YOUR_1PANEL_API_KEY"
export ONEPANEL_TIMEOUT_MS="30000"
export ONEPANEL_SKIP_TLS_VERIFY="false"

CLI Usage

List supported modules:

node dist/scripts/cli.js modules

List actions in one module:

node dist/scripts/cli.js actions monitoring

Send a raw signed request:

node dist/scripts/cli.js request GET /api/v2/dashboard/base/os

Run a grouped module action:

node dist/scripts/cli.js run monitoring getCurrentNode
node dist/scripts/cli.js run websites searchWebsites --input-json '{"page":1,"pageSize":20}'

Print the current auth headers:

node dist/scripts/cli.js sign

OpenClaw Integration

This repository exposes two runtime entrypoints:

  • dist/plugin.js: OpenClaw plugin entry
  • dist/scripts/cli.js: signed CLI for direct local execution

The plugin metadata is defined in openclaw.plugin.json, and the package exports the compiled plugin entry through package.json.

Development

Install dependencies:

npm install

Typecheck:

npm run typecheck

Rebuild only after changing TypeScript source files:

npm run build

Notes

  1. Do not commit real API keys into version control.
  2. If you receive {"code":401,"message":"API ๆŽฅๅฃๅฏ†้’ฅ้”™่ฏฏ"}, first verify the copied key and confirm the 1Panel API settings were saved.
  3. If you receive an IP-related auth error, verify the whitelist and the actual outbound IP of the OpenClaw runtime.
  4. Some node-related endpoints may require 1Panel Pro or XPack.

License

MIT

About

1Panel skills

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors