feat: cli publish (#40)

2026-01-18 21:04:48 +00:00
parent bc6a5f28d9
commit 535dee7ce0
9 changed files with 119 additions and 56 deletions
@@ -1,66 +1,32 @@
-# Kandev Launcher (npx)
+# Kandev

-This package powers `npx kandev` by downloading prebuilt release bundles from GitHub Releases and running them locally. It:
- Detects OS/arch and fetches the matching bundle ZIP.
- Verifies the SHA256 checksum when available.
- Extracts the bundle into `~/.kandev/bin/<version>/<platform>/`.
- Starts the backend binary and waits for the `/health` endpoint.
- Starts the Next.js standalone server with runtime `KANDEV_API_BASE_URL`.
- Uses the latest GitHub Release by default, so runtime bundles update automatically.
-It also supports local dev runs from a repo checkout.
+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.

-## Updates
-
-On `run`, the launcher checks npm for the latest `kandev` CLI version and prompts:
-
-```
-Update available: <current> -> <latest>. Update now? [y/N]
-```
-
-If you accept, it re-runs `npx kandev@latest` with the same arguments.
-This check is skipped in `dev` mode.
-
-Note: the runtime bundles are pulled from the latest GitHub Release by default, even if the CLI version is unchanged. So:
- **New runtime release without CLI publish**: users get new runtime automatically, but no update prompt.
- **New CLI publish**: users get an update prompt and then re-run with the new CLI.
-
-You can disable the prompt with:
+## Start locally

 ```bash
-KANDEV_NO_UPDATE_PROMPT=1 npx kandev
-```
-
-## Usage
-
-```bash
-# Run the latest release bundle
 npx kandev
-
-# Run a specific release tag
-npx kandev run --version v0.1.0
-
-# Local dev (from repo root)
-npx kandev dev
 ```

-## Local Development
+The launcher downloads the latest release bundle, starts the backend + web app, and opens your browser.

-```bash
-pnpm -C apps/cli dev
-```
+## What you get

-## Build / Publish
+- **Task-centric execution**: turn tasks into runnable sessions with streaming updates.
+- **Workspace control**: shell, file, and git access scoped to each task.
+- **Agent orchestration**: run different agent types and resume sessions.
+- **Change visibility**: review diffs and track state per task/session.
+- **Live UI**: WebSocket-driven updates across tasks, messages, and outputs.

-```bash
-pnpm -C apps/cli build
-npm publish --access public
-```
+## Requirements

-The published package name is `kandev`, with a bin entry `kandev`.
+- Node.js (for `npx`)
+- Git (for repository access)
+- Docker (optional; only needed for containerized agents)

-## Environment Overrides
+## Platforms
+
+- macOS (Intel + Apple Silicon)
+- Linux (x64)
+- Windows (x64) (not tested yet)

- `KANDEV_GITHUB_OWNER`, `KANDEV_GITHUB_REPO`: Override the GitHub repo to fetch releases from.
- `KANDEV_GITHUB_TOKEN`: Optional token for GitHub API rate limits.
- `KANDEV_NO_UPDATE_PROMPT=1`: Disable the update prompt.
- `KANDEV_SKIP_UPDATE=1`: Internal guard to avoid update loops.