Quick start

Get Aisman running with your AI coding agent in five minutes.

Topics

Setup in 2 steps

Step 1: Set up your project

Creating a project takes less than a minute:

  1. Register to get immediate access to your dashboard.
  2. Open the Dashboard — Navigate to /dashboard in your browser after signing in.
  3. Create a project — Type a project name in the filter box and press Enter. A "Create project" dialog opens.
    The project filter bar — type a name and press Enter to create a project
    The project filter bar — type a name and press Enter to create a project.
    In it enter:
    The New project dialog with name, acronym, description, root folder, and machine name fields
    The New project dialog — numbered fields match the steps below.
    1. Project name like "Sample Project"
    2. A short project acronym like SAP — this prefixes issue numbers.
    3. Optionally a description.
    4. Project root folder. Click the 'Browse...' button to open your file system explorer and browse to the root folder of your project.
      NOTE: The browser's implementation of file access does not allow the system to report the actual directory, so if you want to remember it within Aisman, copy its path and paste it — after you have selected the root directory — into the text field to the left of the Browse button. If you skip this, everything still works, but the actual folder path won't be displayed in Aisman.
      Aisman creates a .aisman folder in the specified root folder to store instructions and exchange files with your agent.
    5. Machine name — Create a new entry or select an existing one if it matches your current computer.
      This does not have to match the actual computer name, but it prevents collisions of project files checked into version control (Git) when you work on the project from more than one computer.
      Project paths are saved per computer.
Why the root folder? Aisman needs access to your project's filesystem so it can read and write the .aisman/inputs/ and .aisman/outputs/ folders that your AI agent uses to receive instructions and deliver results, and to be able to edit coding agents' instruction files. Everything stays on your machine.

Step 2: Configure your AI coding agent

Your AI coding agent (the host) needs to know that it needs to follow the Aisman instructions in order for Aisman to guide it and record results. This is a one-time setup per project.

Settings - Host instructions
Configuring your AI agent's instruction file — numbered steps correspond to the guide.
  1. Open Settings — Go to Dashboard → Settings → Host instructions.
  2. Select your host — Choose your AI tool from the dropdown (e.g. GitHub Copilot, Cursor, Claude Code). Aisman shows the expected path for that host's instruction file.
  3. Grant file access — If you haven't already, allow Aisman to access your project folder via the browser's File System Access API.
  4. Create or load the file
    1. If no instruction file exists yet, click the + Create file button. Aisman creates it with the correct header that references .aisman/instructions.md.
    2. If the file already exists, click the Insert Aisman instructions button to add the required Aisman directive at the start of the file.
  5. Optionally, add basic coding principles — Click the Add basic coding principles to insert recommended guidelines that help your agent follow best practices. This is just a basic set of helpful coding guidelines to help you start well that has nothing to do with Aisman itself.
  6. Save — Click Save to save the file to disk.
Tip: The .aisman/instructions.md file is the master reference. Your host's instruction file simply points to it—so when Aisman updates instructions, your agent automatically picks up the changes.

Supported hosts out of the box

Using "Custom" you can connect any other instructions file. In fact, you can override any of the predefined locations as well.

Remember: You must Insert Aisman instructions into the instruction file of every AI coding host you want to work with Aisman.
HostInstruction file path
AiderCONVENTIONS.md
Amazon Q Developer.aws\q\rules.md
Claude CodeCLAUDE.md
Cline.clinerules
Codeium.codeium/instructions.md
Continue.continue/config.json
Cursor.cursor/rules
Gemini Code Assist.ai\instructions.md
GitHub Copilot.github/copilot-instructions.md
JetBrains AI.ai\instructions.md
KiloCode.kilocode\instructions.md
RooCode.roo\rules.md
Sourcegraph Cody.ai\instructions.md
Tabnine.ai\instructions.md
Windsurf.windsurfrules
+ [any custom instructions file]User-defined path

Daily workflow in 4 steps

Every AI coding session in Aisman follows four steps. You can run as many sessions as you need—each one able to selectively pick up where the last step left off.

The workflow
The four workflow steps — each numbered step corresponds to the guide below.

Step 1: Select issues

In the Workflow tab, choose which existing issues to include in the next step. Comment to add extra context, constraints, or corrections. This text is included verbatim in the generated prompt for each issue together with the previous comments and the original issue name and description.

Step 2: Write instructions

Here you can type new free-form instructions—the model will subsequently decompose them into discrete issues alongside the existing ones. No manual issue creation needed. Supports Markdown with preview.

Step 3: Generate input

This steps simply just previews the prompt that the AI agent will receive. Click the Start processing the tasks button for Aisman to put automatically all those selected issues with their full history, relationships, and notes—plus your instructions into both your clipboard as well as to an input file saved in .aisman/users/[you]/inputs/. The file is automatically copied to your clipboard.

Step 4: Process output

Paste the contents of your clipboard into your AI agent's input box and let it work.

During this step Aisman tracks the output file creation and when your agent completes the task and completes the JSON result file that it created in .aisman/users/[you]/outputs/ Aisman detects that automatically and notifies you. On your command the output file is parsed, existing issues are updated, new issues are created, and session and issue histories are recorded. A click on the Review results button takes you back to step one which now shows clearly all the unresolved issues of the current session and clearly marks all pre-existing as well as the new issues that were part of this latest session step. You review the implementation and continue working through the workflow until all issues in the session are successfully implemented.

Output recovery: If the agent generates malformed JSON, Aisman attempts automatic repair or provides a targeted fix-prompt so you can send it back for correction. The correction instructions are placed automatically into your clipboard.

What Aisman gives you

Keyboard shortcuts

Aisman provides keyboard shortcuts to speed up common tasks. The most useful ones to get started:

Tab navigation

ShortcutAction
RProject tab
IIssues tab
SAI sessions tab
WWorkflow tab
TSettings tab
14Jump to Workflow steps 1–4
FFocus the current tab's filter box
LSelect the last processed session
Alt+LWalk backward through step execution history
Ctrl+Alt+LWalk forward through step execution history

Markdown formatting (in any text editor)

ShortcutAction
Ctrl+BBold
Ctrl+IItalic
Ctrl+-Strikethrough
Ctrl+Shift+14Heading 1–4
Ctrl+=Bullet list
Ctrl+Shift+=Numbered list
Ctrl+Alt+=Check list
Ctrl+.Inline code
Ctrl+Shift+.Code block
Ctrl+QBlock quote
Ctrl+Shift+LLink

Next steps