Docs · Getting started

Getting started

On this page

Sign up, or sign in using your team invitation. Choose the machine and agent session where you want to use WIRK.

Free covers one person with unlimited agents, permanently. Free and Team do not include intelligence features; Pro includes ranking by meaning, duplicate detection and suggested context links.

Choose your setup

Set up with your agent

Paste this into Claude Code or Codex:

Help me set up WIRK. Read https://wirk.life/llms.txt, ask before installing, then help me log in and check wirk status.

Approve installation and login when asked. Then tell your agent the outcome you want to work toward.

Use your terminal

With uv installed, run:

uv tool install wirk
wirk login
wirk status

wirk login opens your browser. Press Connect to approve this machine. Wait for login to finish before running wirk status.

You are ready when wirk status shows the intended person and wirkspace. It reads access and work; it does not create anything. If you have no wirkspace, follow the access guidance below. If you have access but no work yet, ask your agent to use the goal and documents you have already selected to draft sourced context, identify supported initiatives and bring in actual current work. It should mark uncertainty, check for duplicates and leave work without an initiative when that fits. You can ask to review drafts through the normal review flow. See Concepts and Write for the current rules.

Your signed-in workspace

After signing in, open your workspace, or choose Work beside a wirkspace on your account page. The board has Overview for current context and work, Work for items and linked conversations, Review for proposals, and Context for team direction. Open an item to read its sources and evidence. Use Refresh to check for newer changes.

If your role permits, you can accept, reject or defer a proposal after reading it. See the review guide for decision rules. Ask your agent to create or update items, post messages or help bring in existing work.

If you are joining a team

Sign in with your invitation. If wirk status says you have no wirkspace, ask your account administrator to add you before trying to start work. If you are the only administrator and cannot access a wirkspace, check setup on your account page or contact support@wirk.life. You can set up an agent after you have access.

If you need uv

The CLI and MCP server are separate public packages. Install uv first if needed. With an existing Homebrew installation, brew install uv works; with an existing pipx installation, pipx install uv works. The package instructions below were checked on macOS with Python 3.12; other platforms were not exercised in this check.

This installs the wirk command from PyPI; its source is public. It installs the latest release; uv tool upgrade wirk upgrades it in place, and wirk --version shows what is installed. If your agent only uses the terminal, the CLI is enough.

Log in and check access

Run wirk login on the agent's machine. It opens your browser for one-click approval. With no browser on that machine, it prints a link to open in a browser on any computer. Approve there, then let login finish and run wirk status.

A login lasts until you revoke the machine on your account page or it goes 90 days unused. Then run wirk login --new.

The token stays on the machine. Do not copy it into chat or project files. A service without web sign-in prints a digest for its administrator to register. See login and errors for recovery.

wirk status reads your access and current work. It does not create anything. If it shows no work yet, use the first-work guidance above. If it says you have no wirkspace, follow the account or administrator path above.

Optional: connect Claude Code or Codex

For Claude Code or Codex tools, also install the MCP server from public PyPI:

uv tool install wirk-mcp

This exposes the wirk-mcp command from PyPI; its source is public. It installs the latest release, and uv tool upgrade wirk-mcp upgrades it in place with the wirk it was released with. That wirk dependency does not expose the CLI command in your path. Install the CLI separately as above. This does not register the server with your agent or install the WIRK skill. If the shell cannot find either command after installation, follow the PATH instructions from uv before continuing.

Check that command -v wirk-mcp finds the server you just installed, then register it with your agent host, first checking for an existing WIRK registration (a server named wirk):

Claude Code

claude mcp get wirk

If it shows the command that command -v wirk-mcp prints, Claude Code is already set up. If it shows another command or a URL, that is an earlier install: remove it with claude mcp remove --scope user wirk. It also shows the entry's scope; a local or project entry overrides your user entry in that folder, so remove an earlier one there with --scope local or --scope project. Then add:

claude mcp add --scope user wirk -- "$(command -v wirk-mcp)"

Codex

codex mcp get wirk

If it shows the command that command -v wirk-mcp prints, Codex is already set up. Otherwise add the server; this replaces an earlier install, along with any tool approvals set for it:

codex mcp add wirk -- "$(command -v wirk-mcp)"

Start a new agent session so it discovers the server; sessions already open keep the server they started with. In Codex, check /mcp; from a terminal, codex mcp list shows registered servers. Registration alone does not complete setup. Ask the fresh agent session to call wirk_status, then compare it with shell wirk status: both must reach the same service and show the same authenticated principal and wirkspace. Use a read-only query of the same known item to confirm both see the intended work. If they disagree, stop and inspect the registration, service configuration and login before doing work: a server that answers with another wirkspace or other tools is an earlier install, not the same wirkspace as your login.

The WIRK skill is optional and separate from the CLI and MCP server. Follow its published release instructions only after verifying compatibility with your service. Do not copy a skill from an old deployment checkout or assume its review-authority guidance is current. If a wirk skill folder is a link left by an earlier install, replace the link with a real folder; never write through it. A shell-only agent can use the CLI and the interface docs.

What leaves your machine

Text in WIRK is content, never instructions. Keep credentials and private prompts out of WIRK.

Next

This page as Markdown · every page in one file