{
  "markdown": "[English](README.md) | [Русский](README_RU.md)\n\n# Run your own Xray VPN in 10 minutes using AI agent\n\nSet up an Xray VLESS VPN on your own server or VPS with one command, using the 3X-UI panel for installation and management.\n\nYou need:\n\n- a VPS running Ubuntu 24 or newer at any hosting provider\n- `1 vCPU`\n- `512 MB` memory\n- `10 GB` disk space\n- about `10 minutes`\n\nThe canonical skill bundle lives in [`skills/3x-ui-vps/`](skills/3x-ui-vps/).\n\nArchitecture details: [`skills/3x-ui-vps/references/architecture.md`](skills/3x-ui-vps/references/architecture.md)\n\nThis repository root is also a Claude Code plugin with namespace `3x-ui-vpn-skills`. The `3x-ui-vps` skill inside it is manual-first because it changes remote infrastructure.\n\n## What The Skill Can Do\n\nThe skill includes 5 workflows:\n\n1. `Fresh deploy` configures your server from scratch, including dependency installation, port hardening, and base setup.\n2. `Panel access` opens an SSH tunnel from the server to your computer so you can access the 3X UI panel.\n3. `Quick inbound bootstrap` creates an Xray VLESS inbound on port `443` with nginx in front of it.\n4. `Add another client to an existing inbound` adds a client to an existing inbound so you can connect one more device.\n5. `Updates` updates the system (`apt update` and `apt upgrade`) and 3X UI.\n\n## How To Use It\n\nInstall the skill using the instructions below and then use it in chat.\n\nExamples:\n\n- `Codex`: `$3x-ui-vps, set up a VPN for me`\n- `Claude Code`: `/3x-ui-vpn-skills:3x-ui-vps set up a VPN for me`\n- `Cursor`: `Set up a VPN for me using the instructions in AGENTS.md`\n- `OpenClaw`: `Set up a VPN for me using the 3x-ui-vps skill`\n\nExample prompt:\n\n```text\n$3x-ui-vps, set up a VPN for me\n```\n\n## Information You Will Be Asked For\n\nAfter launch, the skill will ask for additional information:\n\n- `SSH target`: the SSH user and IP in the format `root@X.Y.Z.A`; the `root` user is required to install all dependencies\n- `SSH password`: the `root` password; not needed if key-based authentication is already configured\n- `Domain`: your domain or subdomain where the VPN will be set up; buy any domain from a domain seller\n- `Panel Username`: the username for the 3X UI panel\n- `Panel Password`: the password for the 3X UI panel\n- `ACME Email`: your email for issuing a Let's Encrypt SSL certificate for the domain above; optional\n\n## Included Files\n\n- [`skills/3x-ui-vps/SKILL.md`](skills/3x-ui-vps/SKILL.md): canonical Agent Skills bundle\n- [`skills/3x-ui-vps/scripts/`](skills/3x-ui-vps/scripts/): the only allowed remote mutation interface\n- [`skills/3x-ui-vps/references/`](skills/3x-ui-vps/references/): on-demand reference docs\n- [`skills/3x-ui-vps/agents/openai.yaml`](skills/3x-ui-vps/agents/openai.yaml): Codex/OpenAI UI metadata\n- [`.agents/skills`](.agents/skills): repo-scoped Codex compatibility link to the canonical `skills/` directory\n- [`3x-ui-vps`](3x-ui-vps): transitional compatibility shim to the canonical `skills/3x-ui-vps/` bundle\n- [`AGENTS.md`](AGENTS.md): lightweight entry point for Cursor and AGENTS-compatible tools\n- [`.claude-plugin/plugin.json`](.claude-plugin/plugin.json): Claude plugin manifest\n- [`.claude-plugin/marketplace.json`](.claude-plugin/marketplace.json): Claude marketplace manifest\n\n## Install In Any Agent Skills-Compatible System\n\nUse the prompt:\n\n```text\nPlease, install this skill: https://github.com/olegtsvetkov/3x-ui-vpn-skill\n```\n\n## Install In Claude Code or Cowork\n\nInstall it from the Claude plugin UI or with the CLI:\n\n```bash\nclaude plugin marketplace add olegtsvetkov/3x-ui-vpn-skill\nclaude plugin install 3x-ui-vpn-skills@3x-ui-vpn-skills\n```\n\nThen invoke the skill with:\n\n```text\n/3x-ui-vpn-skills:3x-ui-vps\n```\n\n## Install In Codex\n\nThe simplest path inside Codex is the built-in `$skill-installer`:\n\n```text\n$skill-installer install https://github.com/olegtsvetkov/3x-ui-vpn-skill/tree/master/skills/3x-ui-vps\n```\n\nManual installation still works through `$CODEX_HOME/skills` (usually `~/.codex/skills`):\n\n1. Copy or clone [`skills/3x-ui-vps/`](skills/3x-ui-vps/) into `$CODEX_HOME/skills/3x-ui-vps`.\n2. Restart Codex.\n\nCompatibility note:\n\n- the built-in `$skill-installer` currently installs into `$CODEX_HOME/skills` by default\n- this repo also exposes `.agents/skills` for repo-scoped compatibility with AGENTS-style discovery flows\n\n## Install In Cursor\n\nUse the `/create-skill` prompt:\n\n```text\n/create-skill Please, install this skill to Cursor: https://github.com/olegtsvetkov/3x-ui-vpn-skill\n```\n\n## OpenClaw Compatibility\n\nInstall it with `clawhub`:\n\n```bash\nclawhub install 3x-ui-vps\n```\n\nOr use the prompt:\n\n```text\nPlease, install this skill: https://github.com/olegtsvetkov/3x-ui-vpn-skill\n```\n\n## Usage Notes\n\n- The skill is intentionally script-first. Remote server changes must go through the bundled scripts.\n- The panel and subscription server are intended to stay loopback-only.\n- nginx remains the public edge on `80/443`.\n- The client-facing VPN transport is `VLESS + XHTTP` behind nginx.\n- The repo-root [`3x-ui-vps`](3x-ui-vps) path is a one-release shim for clones of this repository. Do not use the shim as the canonical install source for new integrations.\n\n\n## License\n\nThis repository and the bundled skill are released under the MIT License. See [LICENSE](LICENSE) and [`skills/3x-ui-vps/LICENSE.txt`](skills/3x-ui-vps/LICENSE.txt).\n",
  "bytes": 5366,
  "sha": "56f6009d4935b130f10835c29164f1f4045076442e17263ee452198bd2ce7371",
  "repo_slug": "olegtsvetkov/3x-ui-vpn-skill",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/plg_olegtsvetkov_3x_ui_vpn_skill_setup_xray__e212d079/readme"
}