Skip to content
Browse documentation

Getting started

Use Vopit from the terminal

Work with your team from a terminal with the vopit command, or let scripts and AI models drive Vopit.

The vopit command gives you the same team, projects, account and permissions as the window, in a terminal. Run vopit for an interactive session, or one-line commands for scripts and AI models. When a Vopit window has the project of the current folder open, the terminal joins it, and both show the same requests live. Otherwise, vopit starts Vopit without its window: lighter, and it closes by itself once the last terminal leaves and no request is running.

Install from the terminal

In PowerShell on Windows, one command installs Vopit for your user account and adds vopit to your PATH. No administrator rights are needed. The script downloads the installer published on vopit.fr, checks its size and SHA-256 against the release before running it, and leaves your session as it was. Running it again updates Vopit.

Install Vopit and the vopit command
irm https://vopit.fr/install.ps1 | iex

This installs the full app: the terminal session and the window share one engine, so vopit gui still opens the window. To read the script first, open https://vopit.fr/install.ps1. To remove everything, uninstall Vopit from Windows Settings → Apps; the vopit command leaves your PATH with it.

On Linux with apt (Debian and the distributions based on it, x86_64), one command installs the Vopit package with apt. It downloads the .deb published on vopit.fr and checks its size and SHA-256 against the release before apt installs it; sudo asks for your password. The package adds Vopit to your applications menu and the vopit command as /usr/bin/vopit. Running it again updates Vopit.

Install Vopit and the vopit command on Linux
curl -fsSL https://vopit.fr/install.sh | sh

To read the script first, open https://vopit.fr/install.sh. To remove everything, run sudo apt remove vopit; the vopit command goes with the package.

Linux: the system keyring

On Linux, Vopit keeps your sign-in and keys only in the system keyring (GNOME Keyring, KWallet or another Secret Service), never in plain text. A desktop session usually runs one already. Without it, for example in WSL or over SSH, sign-in stops with "Secure OS credential storage is unavailable".

Install GNOME Keyring
sudo apt install gnome-keyring

Then run vopit login again. The first time, a window asks you to choose a password for the new keyring; in WSL it opens on your Windows desktop. Without any display, start and unlock the keyring in your session yourself before using vopit: it reads the keyring password from standard input.

Unlock the keyring without a display
gnome-keyring-daemon --unlock --components=secrets

Add the command to an installed Vopit

  1. Open Settings → Terminal from the Settings button, on the sign-in screen or in the app.
  2. Choose Add to terminals. Vopit adds its folder to your user PATH.
  3. Open a new terminal window and run vopit --help.

The interactive session

Run vopit in a project folder. Vopit opens that project, then shows the team, the connection, the speed mode and your account. Describe a task and press Enter: the team works on it, its steps appear as they happen, and the result is shown when it finishes. When an agent asks for a permission, choose Allow once, Allow for this project, Always allow or Deny with the arrows and Enter. A folder that is new to Vopit, or whose configuration changed outside Vopit, asks to be trusted first.

Key or commandWhat it does
EnterSends the task to the team.
then EnterStarts a new line.
/Lists commands: /status, /agents, /requests, /board, /cranks, /speed, /pause, /open, /init, /gui, /login, /clear, /exit and more.
Esc twiceStops the running request.
Ctrl+C twiceLeaves the session. Running requests continue in Vopit.
/guiOpens the Vopit window on the same session.

Commands for scripts and AI models

Everything you do in the window has a command: the team and each agent, connections and keys, the Board, Cranks, meetings, project memory, Git, linked folders and infrastructure. Every command accepts --json for machine-readable output. A coding agent with shell access, such as Claude Code or Codex, can use them to drive and configure Vopit.

Point a coding agent at the guide written for it
vopit guide          # how Vopit works, conventions, workflows, every command
vopit help agent create
vopit commands --json
Send a task, answer a permission, wait for the result
vopit -p "Add a dark mode toggle" --json
# exit code 3: an agent asks for a permission
vopit approve <permission-id>
vopit wait <request-id> --json
CommandsWhat they cover
status · open · projects · instances · gui · stop · login · remoteThe engine, your account, the open project, the other Vopits of this computer and Remote.
request · requests · show · wait · cancel · retry · resume · edit · delete · export · integrateTasks for the team and their results. A request ID can be shortened to its first characters.
permissions · approve · deny · pause · unpauseWhat agents ask for, and the request queue.
agents · agent show · create · generate · set · edit · enable · disable · delete · history · templates · toolsEach agent: from a template, a copy, a JSON file or a description the model turns into an agent.
team base · generate · apply · import · export · dissolveThe whole team: the base team, a team designed by the model for your project (Studio), or a team file.
connections · connection use · set · add · remove · test · check · detect · key · accounts · mcpAI connections, API keys (read from stdin, never an argument), ChatGPT accounts and MCP servers.
board · board add · edit · approve · move · start · delete · generate · columns · auto · syncCards, columns, auto-run, and cards planned by the model from a goal.
cranks · crank show · create · set · edit · enable · disable · delete · token · run · flowAutomations, including Crank Flows designed by the model.
meetings · meeting start · say · show · capture · apply · dismiss · invite · endDiscussions with agents, and the decisions, instructions and cards they leave.
memory · git · folders · folder add · infra · network · updatesProject memory, Git, linked folders, servers, the company certificate and app updates.
settings · settings set · speed · schema · api · callAny setting by its path, example JSON for --file, and every engine method.
Exit codeMeaning
0Done.
1Error. The message and a hint are printed, or returned with --json.
2Wrong usage, or a change that needs --yes. Deleting, replacing a team or discarding Git changes only happens with --yes, or after you answer at the terminal.
3A request is waiting for a permission.
4The request finished with a partial result.

Several Vopits at once

Each Vopit window, and each engine started by vopit, works on its own project with its own team and history. A command reaches the Vopit that has the project of the current folder (or of --project) open; otherwise one that has no project yet; otherwise it starts its own engine. It never moves another window to its project, and a project is never open twice.

See every Vopit of this computer, and follow them from your phone
vopit instances      # each window and terminal engine, with its project
vopit remote on      # show them at vopit.fr/remote, signed in with your account

All documentation