Skip to content

Commit 8145845

Browse files
committed
chore: open source polish (MIT, badges, CI)
1 parent 1ecff63 commit 8145845

5 files changed

Lines changed: 75 additions & 5 deletions

File tree

.git-ai/lancedb.tar.gz

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
version https://git-lfs.github.com/spec/v1
2-
oid sha256:1725cd99e2c234c167c4ea0a5c17dec574c7f536b1563f77bc65a0b07fe62216
3-
size 13014
2+
oid sha256:7eabebb06f51cc5d78585c65616207e28eba6e18115b37f0ebb731ca982b59f0
3+
size 13013

.github/workflows/ci.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request: {}
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
test:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
19+
- name: Setup Node
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version: "20"
23+
cache: "npm"
24+
cache-dependency-path: package-lock.json
25+
26+
- name: Install
27+
run: npm ci
28+
29+
- name: Test
30+
run: npm test
31+

LICENSE

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2026 mars167
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# git-ai
22

3+
[![ci](https://github.com/mars167/git-ai-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/mars167/git-ai-cli/actions/workflows/ci.yml)
4+
[![release](https://github.com/mars167/git-ai-cli/actions/workflows/release.yml/badge.svg)](https://github.com/mars167/git-ai-cli/actions/workflows/release.yml)
5+
[![license](https://img.shields.io/github/license/mars167/git-ai-cli)](./LICENSE)
6+
[![npm (github packages)](https://img.shields.io/npm/v/%40mars167%2Fgit-ai?registry_uri=https%3A%2F%2Fnpm.pkg.github.com)](https://github.com/mars167/git-ai-cli/packages)
7+
38
`git-ai` 是一个全局命令行工具:默认行为与 `git` 保持一致(代理系统 git),同时提供 `ai` 子命令用于代码索引与检索能力。
49

510
## 安装
@@ -128,3 +133,7 @@ git-ai ai pack --lfs
128133
```bash
129134
git lfs pull
130135
```
136+
137+
## License
138+
139+
[MIT](./LICENSE)

package.json

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,17 @@
2020
"README.md"
2121
],
2222
"keywords": [],
23-
"author": "",
24-
"license": "ISC",
25-
"description": "",
23+
"author": "mars167",
24+
"license": "MIT",
25+
"description": "A git-compatible CLI with AI indexing/search and an MCP server.",
26+
"repository": {
27+
"type": "git",
28+
"url": "git+https://github.com/mars167/git-ai-cli.git"
29+
},
30+
"bugs": {
31+
"url": "https://github.com/mars167/git-ai-cli/issues"
32+
},
33+
"homepage": "https://github.com/mars167/git-ai-cli#readme",
2634
"engines": {
2735
"node": ">=18"
2836
},

0 commit comments

Comments
 (0)