# AI代码记录器客户端
AI代码记录器的客户端，运行在本地，获取Git信息并与远程服务器通信。
## 一、快速开始
### 1. 安装客户端
**从 PyPI 安装（推荐）：**
```bash
# 直接安装发布版本
pip install ai-code-recorder-client
```
**从源码安装（开发用）：**
```bash
# 克隆仓库并进入客户端目录
git clone <repository-url>
cd ai-code-recorder/client
# 安装开发版本
pip install -e .
```
### 2. 配置 Cursor
编辑 `~/.cursor/mcp.json`：
```json
{
"mcpServers": {
"ai-code-recorder": {
"command": "uvx",
"args": ["ai-code-recorder-client"]
}
}
}
```
### 3. 使用
1. 重启 Cursor
2. 在 Cursor 中输入：`ai-code-recorder init`
3. 开始使用 AI 生成代码，会自动记录
## 二、开发和发布
### 1. 本地开发
如果要参与开发或使用最新功能：
```bash
# 克隆仓库并进入客户端目录
git clone <repository-url>
cd ai-code-recorder/client
# 安装开发依赖
pip install -e .
```
### 2. 发布到 PyPI
#### 发布前准备
1. **安装必要工具**
```bash
pip install build twine
```
2. **配置 PyPI API Token**
- 访问 [PyPI Token 管理页面](https://pypi.org/manage/account/token/)
- 创建新的 API token，作用域选择 "Entire account" 或特定项目
- 设置环境变量：
```bash
export PYPI_API_TOKEN="pypi-your-token-here"
```
#### 一键发布
```bash
# 在客户端目录中执行
./release.sh
```
脚本会自动执行所有发布步骤：
- ✅ 清理旧构建文件
- ✅ 运行测试
- ✅ 构建包文件
- ✅ 检查包质量
- ✅ 测试本地安装
- ✅ 询问是否发布到 PyPI
- ✅ 自动发布（如果选择是）
#### 发布后验证
访问 PyPI 页面确认：https://pypi.org/project/ai-code-recorder-client/
Raw data
{
"_id": null,
"home_page": null,
"name": "ai-code-recorder-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "AI Code Recorder Team <contact@aicodeteam.com>",
"keywords": "ai, code, cursor, development, mcp, recorder",
"author": null,
"author_email": "AI Code Recorder Team <contact@aicodeteam.com>",
"download_url": "https://files.pythonhosted.org/packages/3b/98/c8b7895e9fe03d5928d72e7fd7d11628810263f2e5a027226fc7da2b1e6d/ai_code_recorder_client-1.0.1.tar.gz",
"platform": null,
"description": "# AI\u4ee3\u7801\u8bb0\u5f55\u5668\u5ba2\u6237\u7aef\n\nAI\u4ee3\u7801\u8bb0\u5f55\u5668\u7684\u5ba2\u6237\u7aef\uff0c\u8fd0\u884c\u5728\u672c\u5730\uff0c\u83b7\u53d6Git\u4fe1\u606f\u5e76\u4e0e\u8fdc\u7a0b\u670d\u52a1\u5668\u901a\u4fe1\u3002\n\n## \u4e00\u3001\u5feb\u901f\u5f00\u59cb\n\n### 1. \u5b89\u88c5\u5ba2\u6237\u7aef\n\n**\u4ece PyPI \u5b89\u88c5\uff08\u63a8\u8350\uff09\uff1a**\n\n```bash\n# \u76f4\u63a5\u5b89\u88c5\u53d1\u5e03\u7248\u672c\npip install ai-code-recorder-client\n```\n\n**\u4ece\u6e90\u7801\u5b89\u88c5\uff08\u5f00\u53d1\u7528\uff09\uff1a**\n\n```bash\n# \u514b\u9686\u4ed3\u5e93\u5e76\u8fdb\u5165\u5ba2\u6237\u7aef\u76ee\u5f55\ngit clone <repository-url>\ncd ai-code-recorder/client\n\n# \u5b89\u88c5\u5f00\u53d1\u7248\u672c\npip install -e .\n```\n\n### 2. \u914d\u7f6e Cursor\n\n\u7f16\u8f91 `~/.cursor/mcp.json`\uff1a\n\n```json\n{\n \"mcpServers\": {\n \"ai-code-recorder\": {\n \"command\": \"uvx\",\n \"args\": [\"ai-code-recorder-client\"]\n }\n }\n}\n```\n\n### 3. \u4f7f\u7528\n\n1. \u91cd\u542f Cursor\n2. \u5728 Cursor \u4e2d\u8f93\u5165\uff1a`ai-code-recorder init`\n3. \u5f00\u59cb\u4f7f\u7528 AI \u751f\u6210\u4ee3\u7801\uff0c\u4f1a\u81ea\u52a8\u8bb0\u5f55\n\n## \u4e8c\u3001\u5f00\u53d1\u548c\u53d1\u5e03\n\n### 1. \u672c\u5730\u5f00\u53d1\n\n\u5982\u679c\u8981\u53c2\u4e0e\u5f00\u53d1\u6216\u4f7f\u7528\u6700\u65b0\u529f\u80fd\uff1a\n\n```bash\n# \u514b\u9686\u4ed3\u5e93\u5e76\u8fdb\u5165\u5ba2\u6237\u7aef\u76ee\u5f55\ngit clone <repository-url>\ncd ai-code-recorder/client\n\n# \u5b89\u88c5\u5f00\u53d1\u4f9d\u8d56\npip install -e .\n```\n\n### 2. \u53d1\u5e03\u5230 PyPI\n\n#### \u53d1\u5e03\u524d\u51c6\u5907\n\n1. **\u5b89\u88c5\u5fc5\u8981\u5de5\u5177**\n```bash\npip install build twine\n```\n\n2. **\u914d\u7f6e PyPI API Token**\n- \u8bbf\u95ee [PyPI Token \u7ba1\u7406\u9875\u9762](https://pypi.org/manage/account/token/)\n- \u521b\u5efa\u65b0\u7684 API token\uff0c\u4f5c\u7528\u57df\u9009\u62e9 \"Entire account\" \u6216\u7279\u5b9a\u9879\u76ee\n- \u8bbe\u7f6e\u73af\u5883\u53d8\u91cf\uff1a\n```bash\nexport PYPI_API_TOKEN=\"pypi-your-token-here\"\n```\n\n#### \u4e00\u952e\u53d1\u5e03\n\n```bash\n# \u5728\u5ba2\u6237\u7aef\u76ee\u5f55\u4e2d\u6267\u884c\n./release.sh\n```\n\n\u811a\u672c\u4f1a\u81ea\u52a8\u6267\u884c\u6240\u6709\u53d1\u5e03\u6b65\u9aa4\uff1a\n- \u2705 \u6e05\u7406\u65e7\u6784\u5efa\u6587\u4ef6\n- \u2705 \u8fd0\u884c\u6d4b\u8bd5 \n- \u2705 \u6784\u5efa\u5305\u6587\u4ef6\n- \u2705 \u68c0\u67e5\u5305\u8d28\u91cf\n- \u2705 \u6d4b\u8bd5\u672c\u5730\u5b89\u88c5\n- \u2705 \u8be2\u95ee\u662f\u5426\u53d1\u5e03\u5230 PyPI\n- \u2705 \u81ea\u52a8\u53d1\u5e03\uff08\u5982\u679c\u9009\u62e9\u662f\uff09\n\n#### \u53d1\u5e03\u540e\u9a8c\u8bc1\n\n\u8bbf\u95ee PyPI \u9875\u9762\u786e\u8ba4\uff1ahttps://pypi.org/project/ai-code-recorder-client/",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI\u4ee3\u7801\u8bb0\u5f55\u5668 MCP \u5ba2\u6237\u7aef - \u901a\u8fc7 MCP \u534f\u8bae\u8bb0\u5f55 AI \u751f\u6210\u7684\u4ee3\u7801\u7247\u6bb5",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://github.com/ai-code-team/ai-code-recorder/blob/main/README.md",
"Homepage": "https://github.com/ai-code-team/ai-code-recorder",
"Issues": "https://github.com/ai-code-team/ai-code-recorder/issues",
"Repository": "https://github.com/ai-code-team/ai-code-recorder"
},
"split_keywords": [
"ai",
" code",
" cursor",
" development",
" mcp",
" recorder"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "805728acd3232370bc6fb214f25567002b9d239eed8ce8a8afd20967e6092ee7",
"md5": "86ce8d36987968fa5c3812f1d732f904",
"sha256": "5ac5662ce4409f6a6ae0634d6e99c52b744fe43624dde205e716c134ca416eb4"
},
"downloads": -1,
"filename": "ai_code_recorder_client-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86ce8d36987968fa5c3812f1d732f904",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9237,
"upload_time": "2025-09-14T08:35:56",
"upload_time_iso_8601": "2025-09-14T08:35:56.613663Z",
"url": "https://files.pythonhosted.org/packages/80/57/28acd3232370bc6fb214f25567002b9d239eed8ce8a8afd20967e6092ee7/ai_code_recorder_client-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3b98c8b7895e9fe03d5928d72e7fd7d11628810263f2e5a027226fc7da2b1e6d",
"md5": "20de22009648ddbf14e52e032dc2467f",
"sha256": "8a9a7b69feda2f3642e4c0ce695815a59ec1da652cc81499b162de0803cd36ca"
},
"downloads": -1,
"filename": "ai_code_recorder_client-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "20de22009648ddbf14e52e032dc2467f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8750,
"upload_time": "2025-09-14T08:35:58",
"upload_time_iso_8601": "2025-09-14T08:35:58.140057Z",
"url": "https://files.pythonhosted.org/packages/3b/98/c8b7895e9fe03d5928d72e7fd7d11628810263f2e5a027226fc7da2b1e6d/ai_code_recorder_client-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-14 08:35:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ai-code-team",
"github_project": "ai-code-recorder",
"github_not_found": true,
"lcname": "ai-code-recorder-client"
}
JSON
