@seberto/agcp 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +36 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,36 @@
1
+ # agcp
2
+
3
+ Turn plain English into shell commands using your local AI.
4
+
5
+ ## Requirements
6
+
7
+ - [Ollama](https://ollama.com) running locally
8
+ - At least one model pulled (e.g. `ollama pull gemma3`)
9
+ - Node.js 18+
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ npm install -g @seberto/agcp
15
+ ```
16
+
17
+ ## Usage
18
+
19
+ ```bash
20
+ agcp "show all running processes"
21
+ agcp "commit with message bug fixed"
22
+ agcp "find all js files modified today"
23
+ ```
24
+
25
+ agcp will generate the command, show it to you, and ask before running it.
26
+
27
+ ## How it works
28
+
29
+ 1. You describe what you want in plain English
30
+ 2. agcp sends it to your local Ollama instance
31
+ 3. The suggested command is shown
32
+ 4. You confirm before it runs — nothing executes without your approval
33
+
34
+ ## License
35
+
36
+ ISC
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seberto/agcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "AI CLI that generates and runs shell commands",
5
5
  "type": "module",
6
6
  "bin": {
@@ -8,7 +8,8 @@
8
8
  },
9
9
  "files": [
10
10
  "bin",
11
- "service"
11
+ "service",
12
+ "README.md"
12
13
  ],
13
14
  "scripts": {
14
15
  "start": "node ./bin/agcp.js"