Documentation

Plan work, keep decisions, and finish checked changes with your coding agent.

On this page

Magistr keeps a project’s roadmap, decisions, work in progress, and verification results available to your coding agent. Use it when a project spans tasks or conversations and you want the next session to understand what has already happened.

Your agent still reads and writes code, runs commands, and uses its own model account. Magistr supplies shared project records and tools for planning, source changes, and checks. It does not replace your agent, Git, or backups.

Start here

  1. Install Magistr. The current preview builds from the public source repository.
  2. Connect your agent in the project you want to work on.
  3. Complete a first task, starting from an existing project or an empty folder.

Already connected? Ask your agent to read Magistr’s current context and saved work before making changes. Resume work explains what a new session can recover.

Understand the work

A roadmap describes deliverables and their dependencies. A chunk is one deliverable with a clear finish. During implementation, an objective and tasks track the work needed to deliver it. Checks record verification; artifacts link to the files, commits, and other results.

Concepts explains these relationships. The guides below can also be read independently. Terminal commands run in your shell; skills such as $next in Codex or /next in Claude Code run inside your agent conversation.

Find an answer

Getting started

  • Installation

    Install the CLI preview and confirm that your shell can run it.

  • Connect an agent

    Set up a project for Codex, Claude Code, or another MCP agent.

  • Your first task

    Take one useful change from a clear request to a checked result.

Concepts

  • Concepts

    Understand the records Magistr keeps and how they relate to your project.

Working with Magistr

  • Plan a project

    Create, prioritize, and revise deliverables your agent can finish.

  • Reasoning and research

    Save findings and decisions that a later session can inspect and revise.

  • Working in chunks

    Complete one deliverable or run a bounded sequence of ready work.

  • Verification

    Choose checks, read their results, and know when earlier evidence still applies.

  • Sessions and resuming work

    Continue unfinished work, return to a conversation, or change agents.

  • Feedback

    Capture a problem or idea, investigate it, and turn useful findings into work.

  • Desktop preview

    Open projects, work with an agent, and inspect saved project records.

Reference

  • Command reference

    Look up terminal commands, important options, and their effects.

  • Skills

    Choose a workflow shortcut inside your agent conversation.

  • Configuration

    Set agent preferences and choose the commands that verify your project.

  • Storage and backups

    Locate saved work, back it up, and understand what moving a project preserves.

  • Permissions

    Understand which actions your agent and Magistr can approve or restrict.

Help and maintenance

  • Troubleshooting

    Diagnose setup, connection, ownership, and verification failures without losing work.

  • Upgrades

    Update the preview, check project setup, and recover from conversion conflicts.

  • Remove Magistr

    Remove project connections or the executable while keeping control of saved data.

Contributing

  • Contributing

    Find the source, development instructions, and technical contracts for changing Magistr.

Availability

Magistr is a source preview and has not been publicly released. The CLI preview targets Apple Silicon macOS 15 or later. Registry packages are not published yet. The desktop preview has its own build requirements and limitations.

The recorded build is an optional example of a project using Magistr. You do not need to watch it to follow this manual.