kandev 0.1.3 → 0.1.4
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 +18 -63
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,77 +1,32 @@
|
|
|
1
|
-
# Kandev
|
|
1
|
+
# Kandev
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
- Detects OS/arch and fetches the matching bundle ZIP.
|
|
5
|
-
- Verifies the SHA256 checksum when available.
|
|
6
|
-
- Extracts the bundle into `~/.kandev/bin/<version>/<platform>/`.
|
|
7
|
-
- Starts the backend binary and waits for the `/health` endpoint.
|
|
8
|
-
- Starts the Next.js standalone server with runtime `KANDEV_API_BASE_URL`.
|
|
9
|
-
- Uses the latest GitHub Release by default, so runtime bundles update automatically.
|
|
10
|
-
It also supports local dev runs from a repo checkout.
|
|
3
|
+
Kandev is a local-first AI execution platform for software development work. It pairs a kanban-style task surface with live agent orchestration, file/workspace access, and real-time streaming of changes.
|
|
11
4
|
|
|
12
|
-
##
|
|
13
|
-
|
|
14
|
-
On `run`, the launcher checks npm for the latest `kandev` CLI version and prompts:
|
|
15
|
-
|
|
16
|
-
```
|
|
17
|
-
Update available: <current> -> <latest>. Update now? [y/N]
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
If you accept, it re-runs `npx kandev@latest` with the same arguments.
|
|
21
|
-
This check is skipped in `dev` mode.
|
|
22
|
-
|
|
23
|
-
Note: the runtime bundles are pulled from the latest GitHub Release by default, even if the CLI version is unchanged. So:
|
|
24
|
-
- **New runtime release without CLI publish**: users get new runtime automatically, but no update prompt.
|
|
25
|
-
- **New CLI publish**: users get an update prompt and then re-run with the new CLI.
|
|
26
|
-
|
|
27
|
-
You can disable the prompt with:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
|
-
KANDEV_NO_UPDATE_PROMPT=1 npx kandev
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## Usage
|
|
5
|
+
## Start locally
|
|
34
6
|
|
|
35
7
|
```bash
|
|
36
|
-
# Run the latest release bundle
|
|
37
8
|
npx kandev
|
|
38
|
-
|
|
39
|
-
# Run a specific release tag
|
|
40
|
-
npx kandev run --version v0.1.0
|
|
41
|
-
|
|
42
|
-
# Local dev (from repo root)
|
|
43
|
-
npx kandev dev
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
# Local test the built CLI (from repo root)
|
|
47
|
-
pnpm -C apps/cli build
|
|
48
|
-
pnpm -C apps/cli start
|
|
49
9
|
```
|
|
50
10
|
|
|
51
|
-
|
|
11
|
+
The launcher downloads the latest release bundle, starts the backend + web app, and opens your browser.
|
|
52
12
|
|
|
53
|
-
|
|
54
|
-
pnpm -C apps/cli dev
|
|
55
|
-
```
|
|
13
|
+
## What you get
|
|
56
14
|
|
|
57
|
-
|
|
15
|
+
- **Task-centric execution**: turn tasks into runnable sessions with streaming updates.
|
|
16
|
+
- **Workspace control**: shell, file, and git access scoped to each task.
|
|
17
|
+
- **Agent orchestration**: run different agent types and resume sessions.
|
|
18
|
+
- **Change visibility**: review diffs and track state per task/session.
|
|
19
|
+
- **Live UI**: WebSocket-driven updates across tasks, messages, and outputs.
|
|
58
20
|
|
|
59
|
-
|
|
60
|
-
pnpm -C apps/cli build
|
|
61
|
-
npm publish --access public
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
The published package name is `kandev`, with a bin entry `kandev`.
|
|
21
|
+
## Requirements
|
|
65
22
|
|
|
66
|
-
|
|
23
|
+
- Node.js (for `npx`)
|
|
24
|
+
- Git (for repository access)
|
|
25
|
+
- Docker (optional; only needed for containerized agents)
|
|
67
26
|
|
|
68
|
-
|
|
69
|
-
scripts/release/publish-launcher.sh 0.1.0
|
|
70
|
-
```
|
|
27
|
+
## Platforms
|
|
71
28
|
|
|
72
|
-
|
|
29
|
+
- macOS (Intel + Apple Silicon)
|
|
30
|
+
- Linux (x64)
|
|
31
|
+
- Windows (x64) (not tested yet)
|
|
73
32
|
|
|
74
|
-
- `KANDEV_GITHUB_OWNER`, `KANDEV_GITHUB_REPO`: Override the GitHub repo to fetch releases from.
|
|
75
|
-
- `KANDEV_GITHUB_TOKEN`: Optional token for GitHub API rate limits.
|
|
76
|
-
- `KANDEV_NO_UPDATE_PROMPT=1`: Disable the update prompt.
|
|
77
|
-
- `KANDEV_SKIP_UPDATE=1`: Internal guard to avoid update loops.
|