Setup
This guide describes the shape of a healthy Firstmate home.
Exact installation commands may vary by environment, so treat this page as the checklist.
Prerequisites
- Git is installed and authenticated for the required repositories.
- GitHub access is available through
gh-axi. - The chosen agent runtime is installed and authenticated.
no-mistakesis available for projects that require the full validation path.- MSP Portal can read documentation source repositories that should be published.
Home layout
A Firstmate home contains:
data/for durable private recordsstate/for runtime recordsprojects/for local repository clonesbin/for guarded scripts.agents/skills/for internal skills
First startup check
Run the session-start command for the home and read the digest it prints. Resolve any missing tools or authentication blockers before dispatching work.
Add a documentation source
- Create or clone the source repository.
- Ensure it has
.docs-source.ymlanddocs/. - Add the repository to MSP Portal's
sources.yml. - Run MSP Portal source validation and build checks.
- Open a pull request for the portal registration.
Related page: MSP documentation sync.