Skip to content

Commit 2ff0b0f

Browse files
Hyung Gun Kimclaude
authored and
Hyung Gun Kim
committed
docs: add Aptos Agent Skills documentation page
Add documentation for the aptos-agent-skills repo, covering installation, available Move/TypeScript SDK/project skills, recommended workflow, and community contributions. Includes English and Chinese translations, sidebar entry, and overview page updates. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent c700045 commit 2ff0b0f

File tree

5 files changed

+212
-0
lines changed

5 files changed

+212
-0
lines changed

‎astro.sidebar.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -828,6 +828,7 @@ export const sidebar = [
828828
collapsed: true,
829829
items: ["build/ai/aptos-mcp", "build/ai/aptos-mcp/claude", "build/ai/aptos-mcp/cursor"],
830830
}),
831+
"build/ai/aptos-agent-skills",
831832
{
832833
label: "LLMs.txt",
833834
link: "llms-txt",

‎src/content/docs/build/ai.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ Aptos APIs, query on-chain data, and generate correct Aptos code — without nee
2626
<LinkCard href="/build/ai/aptos-mcp/cursor" title="Cursor" description="Set up the Aptos MCP server for Cursor" />
2727
</CardGrid>
2828

29+
## Aptos Agent Skills
30+
31+
[Aptos Agent Skills](https://github.com/aptos-labs/aptos-agent-skills) provides pre-built AI skills
32+
that give coding assistants deep Aptos expertise — covering Move smart contracts, the TypeScript SDK, and
33+
full-stack dApp scaffolding.
34+
35+
```bash
36+
npx skills add aptos-labs/aptos-agent-skills
37+
```
38+
39+
<LinkCard href="/build/ai/aptos-agent-skills" title="Aptos Agent Skills" description="Browse available skills for Move development, TypeScript SDK, and project scaffolding" />
40+
2941
## LLMs.txt Documentation Feeds
3042

3143
The [LLMs.txt standard](https://llmstxt.org/) provides machine-readable documentation feeds that AI tools

‎src/content/docs/build/ai/aptos-agent-skills.mdx‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: "Aptos Agent Skills"
3+
description: "Pre-built AI skills for Claude Code, Cursor, and GitHub Copilot to write Move smart contracts, use the Aptos TypeScript SDK, and build full Aptos dApps."
4+
sidebar:
5+
label: "Agent Skills"
6+
---
7+
8+
import { LinkCard } from '@astrojs/starlight/components';
9+
10+
[Aptos Agent Skills](https://github.com/aptos-labs/aptos-agent-skills) is a collection of pre-built AI skills that give coding assistants like Claude Code, Cursor, and GitHub Copilot deep expertise in Aptos development. The skills cover Move smart contracts, the TypeScript SDK, and full-stack dApp scaffolding.
11+
12+
<LinkCard href="https://github.com/aptos-labs/aptos-agent-skills" title="Aptos Agent Skills on GitHub" description="Browse the source code, skill definitions, and contribution guidelines" />
13+
14+
## Installation
15+
16+
### Using the Skills CLI (recommended)
17+
18+
```bash
19+
npx skills add aptos-labs/aptos-agent-skills
20+
```
21+
22+
This installs the skills into your project so your AI coding assistant can use them automatically.
23+
24+
### Claude Code Plugin
25+
26+
```bash
27+
claude plugin add aptos-labs/aptos-agent-skills
28+
```
29+
30+
### Manual Installation
31+
32+
Clone the repository and copy the skills into your project's `.claude/skills/` directory:
33+
34+
```bash
35+
git clone https://github.com/aptos-labs/aptos-agent-skills.git
36+
cp -r aptos-agent-skills/skills/ .claude/skills/aptos/
37+
```
38+
39+
## Available Skills
40+
41+
### Move Skills
42+
43+
These skills help AI assistants write, test, audit, and deploy Move smart contracts:
44+
45+
| Skill | Description |
46+
| ---------------------------- | --------------------------------------------------------------------- |
47+
| **write-contracts** | Write Move smart contracts following Aptos best practices |
48+
| **generate-tests** | Generate comprehensive unit and integration tests for Move modules |
49+
| **security-audit** | Audit Move contracts for common vulnerabilities and security issues |
50+
| **deploy-contracts** | Deploy Move modules to Aptos devnet, testnet, or mainnet |
51+
| **search-aptos-examples** | Search official Aptos example contracts for reference implementations |
52+
| **analyze-gas-optimization** | Analyze and optimize Move code for gas efficiency |
53+
| **modernize-move** | Upgrade Move code to use the latest Aptos Move features |
54+
55+
### TypeScript SDK Skills
56+
57+
These skills help AI assistants use the Aptos TypeScript SDK correctly:
58+
59+
| Skill | Description |
60+
| ------------------------- | ----------------------------------------------------------- |
61+
| **use-ts-sdk** | General guidance for using the Aptos TypeScript SDK |
62+
| **ts-sdk-client** | Configure and use the Aptos client for network interactions |
63+
| **ts-sdk-account** | Create and manage Aptos accounts and key pairs |
64+
| **ts-sdk-address** | Work with Aptos addresses and address formats |
65+
| **ts-sdk-transactions** | Build, simulate, sign, and submit transactions |
66+
| **ts-sdk-view-and-query** | Query on-chain data and call view functions |
67+
| **ts-sdk-types** | Use TypeScript types from the SDK correctly |
68+
| **ts-sdk-wallet-adapter** | Integrate wallet connections in frontend applications |
69+
70+
### Project Skills
71+
72+
| Skill | Description |
73+
| ------------------------ | ------------------------------------------------------------------------------ |
74+
| **create-aptos-project** | Scaffold a new Aptos project with Move contracts, TypeScript SDK, and frontend |
75+
76+
## Recommended Workflow
77+
78+
For a typical Aptos dApp, use the skills in this order:
79+
80+
1. **Scaffold** — Use `create-aptos-project` to set up the project structure
81+
2. **Write** — Use `write-contracts` to create your Move smart contracts
82+
3. **Test** — Use `generate-tests` to create comprehensive test coverage
83+
4. **Audit** — Use `security-audit` to check for vulnerabilities
84+
5. **Deploy** — Use `deploy-contracts` to publish to devnet or testnet
85+
6. **Frontend** — Use `ts-sdk-wallet-adapter` and other SDK skills to build the UI
86+
87+
## Community Skills
88+
89+
The repository includes a `community-skills/` directory where anyone can contribute additional skills. To add your own:
90+
91+
1. Create a new skill file following the existing format
92+
2. Submit a pull request to the [aptos-agent-skills repository](https://github.com/aptos-labs/aptos-agent-skills)
93+
94+
See the [CONTRIBUTING.md](https://github.com/aptos-labs/aptos-agent-skills/blob/main/CONTRIBUTING.md) for details on the contribution process.

‎src/content/docs/zh/build/ai.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ AskAptos 聊天机器人已内置于文档站点中——在导航栏右上角
2525
<LinkCard href="/zh/build/ai/aptos-mcp/cursor" title="Cursor" description="为 Cursor 配置 Aptos MCP 服务器" />
2626
</CardGrid>
2727

28+
## Aptos Agent Skills
29+
30+
[Aptos Agent Skills](https://github.com/aptos-labs/aptos-agent-skills) 提供预构建 AI 技能，
31+
为编程助手提供深度 Aptos 专业知识——涵盖 Move 智能合约、TypeScript SDK 和全栈 dApp 脚手架。
32+
33+
```bash
34+
npx skills add aptos-labs/aptos-agent-skills
35+
```
36+
37+
<LinkCard href="/zh/build/ai/aptos-agent-skills" title="Aptos Agent Skills" description="浏览所有可用技能，包括 Move 开发、TypeScript SDK 和项目脚手架" />
38+
2839
## LLMs.txt 文档源
2940

3041
[LLMs.txt 标准](https://llmstxt.org/)提供机器可读的文档源，AI 工具可以摄取这些内容以理解完整的 Aptos

‎src/content/docs/zh/build/ai/aptos-agent-skills.mdx‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: "Aptos Agent Skills"
3+
description: "为 Claude Code、Cursor 和 GitHub Copilot 提供的预构建 AI 技能，用于编写 Move 智能合约、使用 TypeScript SDK 和构建完整的 Aptos dApp。"
4+
sidebar:
5+
label: "Agent Skills"
6+
---
7+
8+
import { LinkCard } from '@astrojs/starlight/components';
9+
10+
[Aptos Agent Skills](https://github.com/aptos-labs/aptos-agent-skills) 是一组预构建 AI 技能，为 Claude Code、Cursor 和 GitHub Copilot 等编程助手提供深度 Aptos 开发专业知识。这些技能涵盖 Move 智能合约、TypeScript SDK 和全栈 dApp 脚手架。
11+
12+
<LinkCard href="https://github.com/aptos-labs/aptos-agent-skills" title="GitHub 上的 Aptos Agent Skills" description="浏览源代码、技能定义和贡献指南" />
13+
14+
## 安装
15+
16+
### 使用 Skills CLI（推荐）
17+
18+
```bash
19+
npx skills add aptos-labs/aptos-agent-skills
20+
```
21+
22+
这会将技能安装到您的项目中，以便 AI 编程助手自动使用它们。
23+
24+
### Claude Code 插件
25+
26+
```bash
27+
claude plugin add aptos-labs/aptos-agent-skills
28+
```
29+
30+
### 手动安装
31+
32+
克隆仓库并将技能复制到项目的 `.claude/skills/` 目录中：
33+
34+
```bash
35+
git clone https://github.com/aptos-labs/aptos-agent-skills.git
36+
cp -r aptos-agent-skills/skills/ .claude/skills/aptos/
37+
```
38+
39+
## 可用技能
40+
41+
### Move 技能
42+
43+
这些技能帮助 AI 助手编写、测试、审计和部署 Move 智能合约：
44+
45+
| 技能 | 描述 |
46+
| ---------------------------- | ------------------------------------------- |
47+
| **write-contracts** | 按照 Aptos 最佳实践编写 Move 智能合约 |
48+
| **generate-tests** | 为 Move 模块生成全面的单元测试和集成测试 |
49+
| **security-audit** | 审计 Move 合约中的常见漏洞和安全问题 |
50+
| **deploy-contracts** | 将 Move 模块部署到 Aptos devnet、testnet 或 mainnet |
51+
| **search-aptos-examples** | 搜索官方 Aptos 示例合约以获取参考实现 |
52+
| **analyze-gas-optimization** | 分析和优化 Move 代码的 gas 效率 |
53+
| **modernize-move** | 将 Move 代码升级为使用最新的 Aptos Move 功能 |
54+
55+
### TypeScript SDK 技能
56+
57+
这些技能帮助 AI 助手正确使用 Aptos TypeScript SDK：
58+
59+
| 技能 | 描述 |
60+
| ------------------------- | ----------------------------- |
61+
| **use-ts-sdk** | 使用 Aptos TypeScript SDK 的通用指导 |
62+
| **ts-sdk-client** | 配置和使用 Aptos 客户端进行网络交互 |
63+
| **ts-sdk-account** | 创建和管理 Aptos 账户和密钥对 |
64+
| **ts-sdk-address** | 处理 Aptos 地址和地址格式 |
65+
| **ts-sdk-transactions** | 构建、模拟、签名和提交交易 |
66+
| **ts-sdk-view-and-query** | 查询链上数据和调用 view 函数 |
67+
| **ts-sdk-types** | 正确使用 SDK 中的 TypeScript 类型 |
68+
| **ts-sdk-wallet-adapter** | 在前端应用中集成钱包连接 |
69+
70+
### 项目技能
71+
72+
| 技能 | 描述 |
73+
| ------------------------ | ------------------------------------------ |
74+
| **create-aptos-project** | 搭建包含 Move 合约、TypeScript SDK 和前端的新 Aptos 项目 |
75+
76+
## 推荐工作流
77+
78+
对于典型的 Aptos dApp，建议按以下顺序使用技能：
79+
80+
1. **搭建项目** — 使用 `create-aptos-project` 设置项目结构
81+
2. **编写合约** — 使用 `write-contracts` 创建 Move 智能合约
82+
3. **测试** — 使用 `generate-tests` 创建全面的测试覆盖
83+
4. **审计** — 使用 `security-audit` 检查漏洞
84+
5. **部署** — 使用 `deploy-contracts` 发布到 devnet 或 testnet
85+
6. **前端** — 使用 `ts-sdk-wallet-adapter` 和其他 SDK 技能构建 UI
86+
87+
## 社区技能
88+
89+
仓库包含一个 `community-skills/` 目录，任何人都可以贡献额外的技能。要添加您自己的技能：
90+
91+
1. 按照现有格式创建新的技能文件
92+
2. 向 [aptos-agent-skills 仓库](https://github.com/aptos-labs/aptos-agent-skills)提交 pull request
93+
94+
详细的贡献流程请参阅 [CONTRIBUTING.md](https://github.com/aptos-labs/aptos-agent-skills/blob/main/CONTRIBUTING.md)。

0 commit comments

Comments
 (0)