@halfagiraf/clawx 0.1.0 → 0.1.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.
- package/README.md +31 -14
- package/logo.png +0 -0
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
1
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/stevenmcsorley/clawx/main/logo.png" alt="Clawx" width="200" />
|
|
3
|
+
</p>
|
|
2
4
|
|
|
3
|
-
|
|
5
|
+
<h1 align="center">Clawx</h1>
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://www.npmjs.com/package/@halfagiraf/clawx"><img src="https://img.shields.io/npm/v/@halfagiraf/clawx" alt="npm version" /></a>
|
|
9
|
+
<a href="https://github.com/stevenmcsorley/clawx/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@halfagiraf/clawx" alt="license" /></a>
|
|
10
|
+
<a href="https://www.npmjs.com/package/@halfagiraf/clawx"><img src="https://img.shields.io/npm/dm/@halfagiraf/clawx" alt="downloads" /></a>
|
|
11
|
+
</p>
|
|
12
|
+
|
|
13
|
+
<p align="center">
|
|
14
|
+
Terminal-first coding agent — runs locally with Ollama, DeepSeek, OpenAI, or any OpenAI-compatible endpoint.
|
|
15
|
+
</p>
|
|
16
|
+
|
|
17
|
+
Clawx is a lean coding/execution agent that can create files, write code, run commands, execute over SSH, and iterate until the job is done. The model decides what to build and how — no file lists, no hand-holding.
|
|
6
18
|
|
|
7
19
|
## What it does
|
|
8
20
|
|
|
@@ -25,19 +37,27 @@ Clawx is a terminal-first agent that can create files, write code, run commands,
|
|
|
25
37
|
## Quick start
|
|
26
38
|
|
|
27
39
|
```bash
|
|
28
|
-
#
|
|
40
|
+
# Install from npm
|
|
41
|
+
npm install -g @halfagiraf/clawx
|
|
42
|
+
|
|
43
|
+
# Configure (see Model Setup below)
|
|
44
|
+
clawx # launches TUI on first run
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Or build from source:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
29
50
|
git clone https://github.com/stevenmcsorley/clawx.git
|
|
30
51
|
cd clawx
|
|
31
52
|
npm install
|
|
32
53
|
npm run build
|
|
33
|
-
|
|
34
|
-
# Configure (see Model Setup below)
|
|
35
|
-
cp .env.example .env
|
|
36
|
-
|
|
37
|
-
# Link the local build as a global command
|
|
38
54
|
npm link
|
|
55
|
+
```
|
|
39
56
|
|
|
40
|
-
|
|
57
|
+
### Usage
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Launch TUI (rich terminal UI — default mode)
|
|
41
61
|
clawx
|
|
42
62
|
|
|
43
63
|
# Launch TUI with an initial prompt
|
|
@@ -53,9 +73,6 @@ clawx --basic
|
|
|
53
73
|
clawx continue
|
|
54
74
|
```
|
|
55
75
|
|
|
56
|
-
> **Note:** After `npm link`, the `clawx` command points to your local install.
|
|
57
|
-
> If you ever run `npm install` again, re-run `npm link` to restore the global link.
|
|
58
|
-
|
|
59
76
|
## Model setup
|
|
60
77
|
|
|
61
78
|
Clawx requires a model that supports **structured tool calling** (returning `tool_calls` in the API response, not just text). This is critical — the agent loop depends on it.
|
|
@@ -468,7 +485,7 @@ clawx chat -d ./my-project
|
|
|
468
485
|
## Programmatic usage
|
|
469
486
|
|
|
470
487
|
```typescript
|
|
471
|
-
import { loadConfig, runAgent, createStreamRenderer } from "clawx";
|
|
488
|
+
import { loadConfig, runAgent, createStreamRenderer } from "@halfagiraf/clawx";
|
|
472
489
|
|
|
473
490
|
const config = loadConfig({
|
|
474
491
|
provider: "openai-completions",
|
package/logo.png
ADDED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@halfagiraf/clawx",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Terminal-first coding agent — runs locally with Ollama, DeepSeek, OpenAI, or any OpenAI-compatible endpoint",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
|
-
"clawx": "
|
|
7
|
+
"clawx": "dist/cli/main.js"
|
|
8
8
|
},
|
|
9
9
|
"main": "./dist/index.js",
|
|
10
10
|
"types": "./dist/index.d.ts",
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
"dist/",
|
|
13
13
|
"README.md",
|
|
14
14
|
"LICENSE",
|
|
15
|
+
"logo.png",
|
|
15
16
|
".env.example",
|
|
16
17
|
"clawx.json.example"
|
|
17
18
|
],
|