Start here
Getting started
From a fresh install to a project with shared context.
You’ll install the CLI, set up a homebase, and connect an application project. You don’t need to change coding agents or move your application code.
1. Install Mindslice
On macOS or Linux with Homebrew:
brew install mindsliceai/tap/mindsliceFor other installations, download the archive for your operating system and architecture from Mindslice Releases. Unpack it and put mindslice (or mindslice.exe on Windows) on your PATH.
End users do not need Node.js or Go. Have Git installed if you intend to use repository-aware features.
Check that the executable is available:
mindslice --version2. Start the local service
Run this from any directory:
mindslice service startThe service manages local homebases and project connections. It keeps running after you close your terminal.
Interactive setup can offer Homebrew users automatic startup at sign-in. This is optional; you can change the preference later with mindslice settings.
3. Give your knowledge a home
Choose a folder separate from your application repository. Replace the example path with your own:
mindslice init /path/to/knowledgeIf you already use a home repo, use that directory instead of creating another knowledge repository.
Choose Home / homebase if the directory has no Mindslice metadata yet. The prompts guide you through registering an existing home, initializing a directory, or cloning a remote into a new destination.
Review the path and any initialization or clone confirmation. Existing metadata is validated rather than overwritten.
Add a little useful Markdown to the homebase: a product overview, a key architectural decision, or the conventions you find yourself explaining repeatedly. You can grow it over time.
A homebase does not have to be a Git repository. If you choose Git, keep it separate from application repositories and manage remote publishing deliberately.
4. Connect your project
Go to the application directory where you work with your coding agent—not your homebase folder:
cd /path/to/your-project
mindslice init .Choose Application project if prompted. Select the homebase, review the project identity and location, and choose the knowledge this project should receive.
Setup can install optional agent instructions, skills, and reminder hooks. Review these choices; they help your agent discover and maintain shared context.
Repeat this step for each project that needs the knowledge.
5. Check your context
From your connected application directory:
mindslice status
mindslice knowledge treeConfirm that the connection and context view are healthy. The tree lists the Markdown selected for this project.
To browse the selected knowledge locally:
mindslice readerOpen the private URL printed by the command. Keep that URL private; the reader session is local, scoped, and expires.
Start a session with understanding
Ask your agent to read the relevant homebase pages before working:
Read the shared product overview and architecture decisions
before implementing this change. Flag any missing context.After a meaningful change, review whether the shared knowledge needs an update. Keep durable facts and reasoning in the homebase, not just in a chat transcript.
If you use Git, review and commit the project descriptor and any agent integration files you want to share. Do not commit generated .mindslice/context/ files.
Next steps
- Learn how to structure a homebase.
- Use your homebase to plan across repositories.
- Understand project selection before connecting more repositories.
- Keep the CLI reference nearby for everyday commands.
