Skip to content

quickstart.md

Latest commit

 

History

History
79 lines (51 loc) · 2.2 KB

quickstart.md

File metadata and controls

79 lines (51 loc) · 2.2 KB
Raw

Quickstart

This is the shortest useful path through the project.

1. Start the app

For local development:

pnpm install
pnpm dev

For a local global CLI install from a clone:

pnpm install
pnpm build
npm install -g .
adadex

Adadex is not published to npm yet, so npm install -g adadex is not currently a valid quick start path.

On a fresh workspace, Adadex opens the Deck setup flow first. The setup card verifies the workspace files, .gitignore, and local prerequisites before you create coordinations.

2. Create or inspect a coordination

If the app is already running, you can create a coordination from the CLI:

adadex coordination create api-backend --description "API runtime and request handling"

Or use the Deck view in the UI.

Each coordination becomes a folder under .adadex/coordinations/<coordination-id>/.

3. Let the agent build the local context

The coordination files are where the job keeps its local context:

  • CONTEXT.md for the local model of that area
  • todo.md for concrete tasks
  • extra markdown files for notes, architecture, handoff, or examples

You do not need to treat these as manual setup that the developer always writes by hand. One of the points of Adadex is that a terminal coding agent can help create, update, and maintain these files from inside the app as the work becomes clearer.

4. Create a terminal

adadex terminal create --name "API worker" --coordination-id api-backend

Use --workspace-mode worktree if you want an isolated git worktree.

5. Delegate from todo items

The runtime can parse incomplete items in todo.md and use them as inputs when spawning child agents from the Deck swarm flow. That means one item can become one worker, or a larger list can become a swarm.

6. Send a message

adadex channel send terminal-2 "Need review on the request parser changes"

What to verify

  • the coordination folder exists
  • the terminal appears in the UI
  • CONTEXT.md and todo.md exist for that coordination
  • todo progress is visible
  • messages show up in the target terminal channel

Next reading