Skip to content

docs: add prominent Agent Skill install instructions #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mars167 merged 1 commit into from
Feb 1, 2026
Merged

docs: add prominent Agent Skill install instructions #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .git-ai/lancedb.tar.gz
View file
Open in desktop
Git LFS file not shown
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,32 @@
[![license](https://img.shields.io/github/license/mars167/git-ai-cli)](./LICENSE)
[![npm version](https://img.shields.io/npm/v/@mars167/git-ai)](https://www.npmjs.com/package/@mars167/git-ai)
[![npm downloads](https://img.shields.io/npm/dm/@mars167/git-ai)](https://www.npmjs.com/package/@mars167/git-ai)
[![Agent Skill](https://img.shields.io/badge/Agent_Skill-git--ai--mcp-blue)](https://skills.sh)

[🇨🇳 简体中文](./README.zh-CN.md) | **English**

---

<div align="center">

### 🚀 Quick Install

**For AI Agents (Claude Code, Cursor, Windsurf, etc.)**

```bash
npx skills add mars167/git-ai-cli/skills/git-ai-mcp
```

**For CLI Usage**

```bash
npm install -g @mars167/git-ai
```

</div>

---

## Adding a Semantic Layer to Your Codebase, Enabling AI to Evolve from "Reading Code" to "Understanding Code"

**Code semantics should be versioned and traceable, just like code itself**
Expand Down
21 changes: 21 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,32 @@
[![license](https://img.shields.io/github/license/mars167/git-ai-cli)](./LICENSE)
[![npm version](https://img.shields.io/npm/v/@mars167/git-ai)](https://www.npmjs.com/package/@mars167/git-ai)
[![npm downloads](https://img.shields.io/npm/dm/@mars167/git-ai)](https://www.npmjs.com/package/@mars167/git-ai)
[![Agent Skill](https://img.shields.io/badge/Agent_Skill-git--ai--mcp-blue)](https://skills.sh)

**简体中文** | [English](./README.md)

---

<div align="center">

### 🚀 快速安装

**AI Agent 技能安装 (Claude Code, Cursor, Windsurf 等)**

```bash
npx skills add mars167/git-ai-cli/skills/git-ai-mcp
```

**CLI 工具安装**

```bash
npm install -g @mars167/git-ai
```

</div>

---

## 为代码库添加语义层，让 AI 从"读代码"进化到"懂代码"

**代码的语义，应该像代码本身一样版本化、可追溯**
Expand Down