sagit-chu/flvx/flvx-api
Claude Code and agent skill by sagit-chu/flvx
- community
Checking that the SKILL.md file is still in the repository.
Operate FLVX traffic forwarding management system via REST API. Supports user/node/tunnel/forward management, federation clustering, and traffic monitoring. Use when user wants to manage FLVX panel programmatically or via natural language.
Install
npx vskill@latest install sagit-chu/flvx/flvx-apiSKILL.md
FLVX API Operations
Operate FLVX panel through REST API. All endpoints use POST method and return JSON with {code, msg, data, ts} envelope.
Supported AI Tools
| Tool | Installation | Notes | |
|---|---|---|---|
| OpenCode | npm i -g @flvx/skill-api or ln -s . ~/.agents/skills/flvx-api | Auto-loads from ~/.agents/skills/ | |
| OpenClaw | Same as OpenCode | Compatible skill format | |
| Claude Code | Copy SKILL.md to CLAUDE.md or ~/.claude/CLAUDE.md | Uses context file instead of skills |
Prerequisites
Set environment variables before starting:
Security tip: Add to ~/.flvx/.env and source on demand:
Authentication Flow
Session Token Cache
- Token is cached only for the current conversation
- New conversation = fresh login required
- Token is NOT written to disk (security)
Auto-Login Pattern
Login Request
Response:
Authentication Rules
| Header | Value | Critical | |
|---|---|---|---|
Authorization | <jwt_token> | ⚠️ NO "Bearer" prefix! | |
Content-Type | application/json | All requests use JSON |
Quick Start Workflow
Intent → API Mapping
| User Intent | API Endpoint | Reference | |
|---|---|---|---|
| "登录" / "查看我的信息" | /api/v1/user/package | auth | |
| "创建用户" / "添加用户" | /api/v1/user/create | users | |
| "查看用户列表" / "所有用户" | /api/v1/user/list | users | |
| "重置流量" | /api/v1/user/reset | users | |
| "添加节点" / "新建节点" | /api/v1/node/create | nodes | |
| "查看节点" / "节点状态" | /api/v1/node/list | nodes | |
| "安装命令" / "部署节点" | /api/v1/node/install | nodes | |
| "升级节点" | /api/v1/node/upgrade | nodes | |
| "创建隧道" / "新建隧道" | /api/v1/tunnel/create | tunnels | |
| "分配隧道给用户" | /api/v1/tunnel/user/assign | tunnels | |
| "创建转发" / "新建转发" / "添加转发" | /api/v1/forward/create | forwards | |
| "暂停转发" | /api/v1/forward/pause | forwards | |
| "恢复转发" | /api/v1/forward/resume | forwards | |
| "删除转发" | /api/v1/forward/delete | forwards | |
| "查看我的转发" / "转发列表" | /api/v1/forward/list | forwards | |
| "查看流量" / "流量统计" | /api/v1/forward/list or /api/v1/user/package | forwards | |
| "诊断转发" / "测试连通性" | /api/v1/forward/diagnose | forwards | |
| "创建限速规则" | /api/v1/speed-limit/create | speed-limits | |
| "联邦共享" / "节点共享" | /api/v1/federation/share/create | federation | |
| "导出备份" | /api/v1/backup/export | backup | |
| "导入备份" | /api/v1/backup/import | backup |
HTTP Request Template
Bash/curl (with auto-login)
Python (requests)
Node.js (fetch)
Response Handling
Success:
Error:
Pattern:
Permission Model
| role_id | Type | Access | |
|---|---|---|---|
| 0 | Admin | All endpoints | |
| 1 | Regular | Forward CRUD, own profile, assigned tunnels only |
Non-admin users can only see/modify their own resources.
Module Reference
| Module | Endpoints | Reference | |
|---|---|---|---|
| Auth | login, captcha | auth.md | |
| Users | CRUD, reset, password | users.md | |
| Nodes | CRUD, install, upgrade, status | nodes.md | |
| Tunnels | CRUD, user assignment | tunnels.md | |
| Forwards | CRUD, pause/resume, diagnose | forwards.md | |
| Groups | User/tunnel groups, permissions | groups.md | |
| Speed Limits | CRUD | speed-limits.md | |
| Federation | Share, remote nodes | federation.md | |
| Backup | Export/import | backup.md | |
| Config | System settings | config.md | |
| Types | TypeScript interfaces | types.md | |
| Errors | Error codes | errors.md | |
| Examples | Code samples | examples/ |
Critical Rules
- ⚠️ NO "Bearer" prefix -
Authorization: <token>, NOTAuthorization: Bearer <token> - All endpoints use POST - Including list/get operations
- code === 0 means success - Any other value is an error
- Traffic units: User.flow is GB, in_flow/out_flow are bytes
- Timestamps: All timestamps are milliseconds since epoch
- Token is session-scoped: Cache in memory only, not on disk
Common Workflows
Workflow 1: New User Onboarding (Admin)
Workflow 2: Add New Node (Admin)
Workflow 3: Create Forward (Any User)
Workflow 4: Node Maintenance (Admin)
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/flvx-api/SKILL.md
Popularity
- Repository stars
- 218
- Repository forks
- 51
- 7-day trend score
- 27
Stars and forks are for the whole GitHub repository, not this skill alone. Refreshed 19 Mar 2026, 7 months ago.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/sagit-chu/flvx/flvx-api)