Docs/Getting started

Getting started

Create and run a local TaskWish service.

Requirements

TaskWish uses Bun by default and also supports Node.js 20+. Use bunx and bun, npx and npm run start:node, or the platform installer.

Terminal
bunx @taskwish/create-project
cd my-taskwish-app
bun start

Choose a starter

The interactive installer offers five templates: empty, todo, agent-loops, agent-graphs, and software-factory.

Terminal
bunx @taskwish/create-project my-app --template todo

Your project

taskwish.ts starts the server. Each actor lives in its own folder with an actor definition, one file per action, an index that exports the service, and a colocated test.

taskwish.ts
import { Console } from "@taskwish/console";
import { Server } from "@taskwish/server";
import { Greeter } from "./src/greeter";

await Server("TaskWish Greeter", {
  apps: [Console()],
  workspace: [Greeter],
});
Note
When the server starts, it prints its local URL and a generated API key. Open the URL to use Console.