Help & setup guide

Everything you need to get started with Aisman.

Topics

Getting started

  1. Launch Aisman — Navigate to /dashboard in your browser.
  2. Create a project — Type a project name in the filter box and press Enter.
  3. Set the root folder — Point to your project's root directory on your local machine. Aisman creates a .aisman folder there for instructions and file exchange.
  4. Configure your host — Go to Settings → Host Instructions, select your host, and insert the Aisman instructions header.
Tip: The .aisman/instructions.md file is automatically referenced by your agent’s instruction file. This is how the agent knows to generate structured output.

Projects

Each project corresponds to a codebase you're working on. The project detail view shows:

Workflow (4 steps)

Step 1: Select issues

Choose which existing issues to include in this AI session step. You can also write new free-form instructions — the agent will decompose them into discrete issues.

Step 2: Instructions

Add context, special requirements, or constraints. The text is included verbatim in the generated prompt. Supports Markdown with live preview.

Step 3: Generate

Aisman generates a structured instruction prompt containing your selected issues with their full context (parent hierarchy, notes, relationships) plus free-form instructions. The prompt file is saved in .aisman/inputs/ and automatically copied to your clipboard.

Step 4: Process output

When your model completes its task, it drops a JSON result file into .aisman/outputs/. Aisman auto-detects the file, parses it, updates task statuses, creates new issues, and records session history automatically.

Output recovery: If an agent generates malformed JSON, Aisman automatically attempts to repair common formatting errors or provides a targeted fix-prompt for the agent.

Issues

Issues are created automatically by the model from your free-form text. Each issue has:

AI sessions

Sessions group related work steps. Each step represents one round of agent interaction. Sessions are owned by the user who created them — only the creator can continue a session in the Workflow tab.

Session issues

The Session issues tab shows every issue linked to the session via the SessionIssue table. Each entry displays a touch count indicating how many steps interacted with that issue:

Adding issues to a session

Click the Add issues button on a session you own to enter add-issue mode. In this mode:

Session steps

Each step shows per-step outcomes and metrics:

Settings

Host Instructions

Manage the instruction files for each supported host. The instructions tell the model about Aisman's input/output format and how to create/update issues.

Aisman Instructions (Template)

The master template for the .aisman/instructions.md file. Contains replacement tokens (like {{STATUSES}}, {{TYPES}}) that are filled with your project's actual data when rendered.

General Settings

Configure instruction mode (automatic per tool or custom file), and other application-wide settings.

Auto-detection

When a project root is set, Aisman uses the browser's File System Access API to scan <project root>/.aisman/outputs/ for new JSON files. Detected files appear in the project detail panel with a notification badge.

Supported hosts

HostInstructions FileAuto-Detect
GitHub Copilot.github/copilot-instructions.mdVia .aisman/outputs
Cursor.cursor/rulesVia .aisman/outputs
Claude CodeCLAUDE.mdVia .aisman/outputs
Windsurf.windsurfrulesVia .aisman/outputs
RooCode.roo/rulesVia .aisman/outputs
KiloCode.kilocode/rulesVia .aisman/outputs
Continue.continue/config.jsonVia .aisman/outputs
Aider.aider/conventions.mdVia .aisman/outputs
Codeium.codeium/instructions.mdVia .aisman/outputs
CustomUser-defined pathVia .aisman/outputs
@section Scripts { }