@halfagiraf/clawx 0.1.0 → 0.1.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.
- package/README.md +16 -11
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -25,19 +25,27 @@ Clawx is a terminal-first agent that can create files, write code, run commands,
|
|
|
25
25
|
## Quick start
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
#
|
|
28
|
+
# Install from npm
|
|
29
|
+
npm install -g @halfagiraf/clawx
|
|
30
|
+
|
|
31
|
+
# Configure (see Model Setup below)
|
|
32
|
+
clawx # launches TUI on first run
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Or build from source:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
29
38
|
git clone https://github.com/stevenmcsorley/clawx.git
|
|
30
39
|
cd clawx
|
|
31
40
|
npm install
|
|
32
41
|
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
42
|
npm link
|
|
43
|
+
```
|
|
39
44
|
|
|
40
|
-
|
|
45
|
+
### Usage
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Launch TUI (rich terminal UI — default mode)
|
|
41
49
|
clawx
|
|
42
50
|
|
|
43
51
|
# Launch TUI with an initial prompt
|
|
@@ -53,9 +61,6 @@ clawx --basic
|
|
|
53
61
|
clawx continue
|
|
54
62
|
```
|
|
55
63
|
|
|
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
64
|
## Model setup
|
|
60
65
|
|
|
61
66
|
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 +473,7 @@ clawx chat -d ./my-project
|
|
|
468
473
|
## Programmatic usage
|
|
469
474
|
|
|
470
475
|
```typescript
|
|
471
|
-
import { loadConfig, runAgent, createStreamRenderer } from "clawx";
|
|
476
|
+
import { loadConfig, runAgent, createStreamRenderer } from "@halfagiraf/clawx";
|
|
472
477
|
|
|
473
478
|
const config = loadConfig({
|
|
474
479
|
provider: "openai-completions",
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@halfagiraf/clawx",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
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",
|