@rxpm/forge-cli 0.0.1 → 0.0.2

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 +9 -29
  2. package/package.json +9 -1
package/README.md CHANGED
@@ -17,41 +17,21 @@ A terminal-based AI coding agent built with Node.js, TypeScript, and the Vercel
17
17
 
18
18
  ## Installation
19
19
 
20
- 1. **Clone the repository**:
20
+ Install the package via npm:
21
21
 
22
22
  ```bash
23
- git clone <repository-url>
24
- cd forge
23
+ npm install -g @rxpm/forge-cli
25
24
  ```
26
25
 
27
- 2. **Install dependencies**:
26
+ ## Environment Variables
28
27
 
29
- ```bash
30
- npm install
31
- ```
32
-
33
- 3. **Configure Environment**:
34
-
35
- Create a `.env` file in the root directory:
36
-
37
- ```env
38
- OLLAMA_API_URL="https://your-ollama-endpoint"
39
- OLLAMA_API_KEY="your-api-key-if-needed"
40
- ```
41
-
42
- 4. **Build the project**:
28
+ Configure the following environment variables:
43
29
 
44
- ```bash
45
- npm run build
46
- ```
47
-
48
- 5. **Link the CLI (Optional)**:
49
-
50
- To use the `agent` command globally:
51
-
52
- ```bash
53
- npm link
54
- ```
30
+ | Variable | Description | Default |
31
+ | ---------------------- | ------------------------------------- | ------------------------ |
32
+ | `OLLAMA_API_URL` | URL of the Ollama server | `http://localhost:11434` |
33
+ | `OLLAMA_API_KEY` | API key for the Ollama server | - |
34
+ | `OLLAMA_DEFAULT_MODEL` | Default model to use for the AI agent | `gpt-oss:120b` |
55
35
 
56
36
  ## Usage
57
37
 
package/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@rxpm/forge-cli",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "description": "Open source AI coding agent",
5
5
  "type": "module",
6
+ "preferGlobal": true,
6
7
  "bin": {
7
8
  "forge": "./dist/index.js"
8
9
  },
@@ -24,6 +25,13 @@
24
25
  "url": "https://gitlab.com/rajatxs"
25
26
  },
26
27
  "license": "ISC",
28
+ "markdown": "standard",
29
+ "repository": "https://codeberg.org/rajatxt/forge.git",
30
+ "readme": "https://codeberg.org/rajatxt/forge#readme",
31
+ "bugs": {
32
+ "email": "rajatxt@proton.me",
33
+ "url": "https://codeberg.org/rajatxt/forge/issues"
34
+ },
27
35
  "dependencies": {
28
36
  "ai": "^6.0.137",
29
37
  "chalk": "^5.6.2",