Skip to content

Commit d5cc6d6

Browse files
xesrevinuGit Agent
andcommitted
docs(cli): update readme and assets for ai-commit
- Update README to reflect ai-commit CLI usage and commands - Bump version to 0.0.1 in package.json - Add sceen-recording.mp4 asset for CLI demo This commit updates the documentation to reflect the ai-commit CLI usage, bumps the package version, and adds a demo video asset to the repo. Co-Authored-By: Git Agent <noreply@git-agent.dev>
1 parent d56e452 commit d5cc6d6

3 files changed

Lines changed: 49 additions & 9 deletions

File tree

README.md

Lines changed: 48 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,52 @@
1-
# git-agent-cli
1+
# ai-commit
22

3-
Effect v4 rewrite of `git-agent`, using an Effect CLI structure and supporting
4-
both Git and Jujutsu (`jj`) repositories.
3+
`ai-commit` is the TypeScript / Effect port of the original Go-based
4+
`git-agent`, built with an Effect CLI structure and supporting both Git and
5+
Jujutsu (`jj`) repositories.
6+
7+
## Demo
8+
9+
<video src="./docs/sceen-recording.mp4" controls muted playsinline>
10+
Your browser does not support the video tag.
11+
</video>
12+
13+
## Acknowledgements
14+
15+
Credit goes to the original author of the Go implementation at
16+
[`GitAgentHQ/git-agent-cli`](https://github.com/GitAgentHQ/git-agent-cli).
17+
This project is an independent TypeScript / Effect re-port of that work. It is
18+
not affiliated with, maintained by, or endorsed by GitAgentHQ.
19+
20+
## Install
21+
22+
```bash
23+
npx @effect-x/ai-commit --help
24+
```
25+
26+
```bash
27+
DESCRIPTION
28+
AI-first Git/JJ CLI for atomic commits and generated messages.
29+
30+
USAGE
31+
git-agent <subcommand> [flags]
32+
33+
GLOBAL FLAGS
34+
--help, -h Show help information
35+
--version Show version information
36+
--completions choice Print shell completion script
37+
--log-level choice Sets the minimum log level
38+
39+
SUBCOMMANDS
40+
commit Generate and create commit(s) with AI-generated messages.
41+
config Manage git-agent configuration.
42+
init Initialize git-agent in the current repository.
43+
version Print the git-agent version.
44+
```
545

646
## Goals
747

848
- keep `init`, `commit`, `config`, and `version`
9-
- port orchestration from Go services to Effect services
49+
- re-port orchestration from the original Go services into Effect services
1050
- support both `git` and `jj`
1151
- keep OpenAI-compatible provider support
1252

@@ -20,8 +60,8 @@ bun run check
2060
## Commands
2161

2262
```bash
23-
git-agent version
24-
git-agent config show --cwd .
25-
git-agent init --scope --gitignore
26-
git-agent commit --intent "split auth fix"
63+
ai-commit version
64+
ai-commit config show --cwd .
65+
ai-commit init --scope --gitignore
66+
ai-commit commit --intent "split auth fix"
2767
```

docs/sceen-recording.mp4

303 KB
Binary file not shown.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@effect-x/ai-commit",
3-
"version": "0.1.0",
3+
"version": "0.0.1",
44
"description": "Effect rewrite of git-agent with git and jj support.",
55
"keywords": [
66
"cli",

0 commit comments

Comments
 (0)