Docs · Mindfries CLI
Take an assessment from your own terminal.
The Mindfries CLI signs you in, sets up the task workspace in your editor, gives you an assistant in the terminal, and hands your work in.
These docs are for version 2 of the Mindfries CLI. Run mindfries --version to check which one you have.
Quick start
Four steps, start to hand-in.
Install the CLI
Install Mindfries with a single command. It puts mindfries on your PATH.
In PowerShell
$ irm https://mindfries-cli.onrender.com/install.ps1 | iex
If a terminal that was already open doesn’t find mindfries, open a new one.
Start a session
Sign in through the browser and confirm the code, then authorise GitHub (first time only). Mindfries sets up the workspace and opens your editor.
$ mindfries start
Work in your environment
Work in your editor and commit and git push as usual. Whenever you want help, open the assistant in a second terminal while start keeps running.
$ mindfries agent
Check the time left, your assistant budget and your Git state at any time with mindfries status.
Submit or stop
When you’re done, submit runs the task’s checks, shows your changes, commits, pushes to your GitHub and hands in. stop ends the assessment without submitting.
$ mindfries submit
$ mindfries stop
Installation
Run once. This puts mindfries on your PATH.
| OS | Command |
|---|---|
| Windows (PowerShell) | irm https://mindfries-cli.onrender.com/install.ps1 | iex |
| macOS / Linux | curl -fsSL https://mindfries-cli.onrender.com/install.sh | sh |
If a terminal that was already open doesn’t find mindfries, open a new one.
CLI commands
Everything the CLI does.
| Command | What it does |
|---|---|
mindfries start | Signs you in through the browser, connects GitHub, sets up the workspace, opens your editor and runs the session watcher. Run it again to carry on after a restart or to reopen the editor. |
mindfries agent | Opens the coding and research assistant in the terminal. Use a second terminal while start keeps running. |
mindfries status | Shows the session, time left, assistant budget, workspace, GitHub repo, watcher and Git state. |
mindfries submit | Runs the task’s checks, shows your changes, commits, pushes to your GitHub and hands in. |
mindfries stop | Ends the assessment without submitting and removes this computer’s credentials. Your code stays. |
mindfries doctor | Checks this computer is ready (OS, Git, disk, connection, editor, runtimes). Changes nothing. |
mindfries --version | Shows the version. |
mindfries help | Lists the commands. mindfries <command> --help shows a command’s flags. |
Flags
Every flag, by command. mindfries <command> --help shows the same list in the terminal.
mindfries start
| Flag | Meaning |
|---|---|
--dir <folder> | Where the workspace goes (default: it asks) |
--ide <id> | Editor to open: vscode, intellij, pycharm, webstorm, goland, clion, rider, phpstorm, rubymine, rustrover, zed, or manual |
--no-browser | Print the sign-in address instead of opening the browser |
--yes | Accept the defaults instead of asking |
<setup-code> | Optional: a code from the dashboard instead of signing in |
mindfries agent
| Flag | Meaning |
|---|---|
--new | Start a new conversation instead of carrying on the last one |
mindfries submit
| Flag | Meaning |
|---|---|
-m "<message>" | Commit message (default: it asks) |
--url <address> | Where you deployed it, if the task asks (default: it asks) |
--yes | Don’t ask; hand in with the defaults |
mindfries stop
| Flag | Meaning |
|---|---|
--yes | Don’t ask for confirmation |
mindfries doctor
| Flag | Meaning |
|---|---|
--dir <folder> | The folder the workspace will go in (default: your home folder) |
Inside the agent
Once mindfries agent is open, type a slash command or use these keys.
| Command | What it does |
|---|---|
/help | Show the commands and keys |
/new | Start a new conversation |
/budget | Show the tokens left |
/clear | Clear the screen |
/exit | Leave (typing exit works too). Your session carries on. |
Keys
| Key | What it does |
|---|---|
| Enter | Send |
| CtrlJ | New line (pasting several lines works too) |
| ↑↓ | Earlier messages |
| Tab | Complete a /command |
| Esc | Stop the agent while it’s working; otherwise clear the box |
| CtrlC | Clear the box; press twice to exit |
Approving edits and commands
When the agent proposes an edit or a command, choose 1. Yes or 2. No: use the arrows and Enter, a number, y or n, or Esc for No.
A typical session
What a full assessment looks like.
- 1
mindfries start: confirm the code in the browser, then authorise GitHub (first time only). - 2Work in your editor. Commit and
git pushas usual. - 3
mindfries agentin a second terminal, whenever you want help. - 4
mindfries statusat any time. - 5
mindfries submitwhen you’re done, ormindfries stopto end without submitting.