--- url: https://bishop.agentdeployment.co/reference/cli.md description: Every bishop command and flag, generated from bishop --help. --- # CLI Reference Every command and flag, as `bishop --help` prints them. `bishop` with no command starts the gateway. Everything else runs and exits. Options before a command belong to `bishop` itself, and options after it belong to the command. ## `bishop` ``` Usage: bishop [options] [command] An agent gateway. Runs an agent and connects it to Slack, email, and Teams. Options: -v, --version output the version number --agent the agent's directory, or a git URL to clone; defaults to the current directory --harness which SDK runs the agent --model the model to run, in the harness's own naming --effort how hard the model should think, in the harness's own naming --auto-update for a git-URL --agent, check for a new commit at the start of every new thread -h, --help display help for command Commands: gc [options] Collect the snapshots, worktrees, and rows old conversations left behind schedules Prompts the agent runs on a clock, and where their answers go gmail Gmail interface commands github GitHub credentials for the agent nono The nono sandbox the agent runs under slack Slack interface commands teams Microsoft Teams interface commands ``` ### `bishop gc` ``` Usage: bishop gc [options] Collect the snapshots, worktrees, and rows old conversations left behind Options: --max-age-days how long a quiet thread's remains are kept; defaults to gc.maxAgeDays, then 30 --agent only this agent's snapshots; defaults to every agent Bishop has cloned here -h, --help display help for command ``` ### `bishop schedules` ``` Usage: bishop schedules [options] [command] Prompts the agent runs on a clock, and where their answers go Options: -h, --help display help for command Commands: list Everything scheduled here, in your own time zone add [options] Add a schedule rm Remove a schedule disable Stop a schedule firing, keeping it enable Start a disabled schedule firing again, from now help [command] display help for command ``` #### `bishop schedules list` ``` Usage: bishop schedules list [options] Everything scheduled here, in your own time zone Options: -h, --help display help for command ``` #### `bishop schedules add` ``` Usage: bishop schedules add [options] Add a schedule Options: --name what a person sees in a list, and the subject of an email --cron five-field cron, or @daily and friends --prompt what the agent is asked, including when to stay quiet --to #channel or @person for Slack, an address for Gmail --tz IANA zone the expression is read in; defaults to this machine --interface which interface delivers, when --to is ambiguous -h, --help display help for command ``` #### `bishop schedules rm` ``` Usage: bishop schedules rm [options] Remove a schedule Options: -h, --help display help for command ``` #### `bishop schedules disable` ``` Usage: bishop schedules disable [options] Stop a schedule firing, keeping it Options: -h, --help display help for command ``` #### `bishop schedules enable` ``` Usage: bishop schedules enable [options] Start a disabled schedule firing again, from now Options: -h, --help display help for command ``` ### `bishop gmail` ``` Usage: bishop gmail [options] [command] Gmail interface commands Options: -h, --help display help for command Commands: setup [options] Authorize a Gmail mailbox, or check the one already configured help [command] display help for command ``` #### `bishop gmail setup` ``` Usage: bishop gmail setup [options] Authorize a Gmail mailbox, or check the one already configured Options: --no-browser print a URL to open elsewhere instead of opening one here -h, --help display help for command ``` ### `bishop github` ``` Usage: bishop github [options] [command] GitHub credentials for the agent Options: -h, --help display help for command Commands: setup [options] Give the agent a GitHub token, or check the one it's using help [command] display help for command ``` #### `bishop github setup` ``` Usage: bishop github setup [options] Give the agent a GitHub token, or check the one it's using Options: --no-prompt don't offer to run `gh auth login` --print write the credential to stdout as JSON instead of to .env --temporary log in without touching this machine's own gh login -h, --help display help for command ``` ### `bishop nono` ``` Usage: bishop nono [options] [command] The nono sandbox the agent runs under Options: -h, --help display help for command Commands: setup [options] Write a nono profile that lets a sandboxed agent push help [command] display help for command ``` #### `bishop nono setup` ``` Usage: bishop nono setup [options] Write a nono profile that lets a sandboxed agent push Options: --name the profile name (default: "bishop") -h, --help display help for command ``` ### `bishop slack` ``` Usage: bishop slack [options] [command] Slack interface commands Options: -h, --help display help for command Commands: setup [options] Create and install a Slack app, and save its credentials here manifest [options] Print the app manifest, for creating an app in Slack by hand help [command] display help for command ``` #### `bishop slack setup` ``` Usage: bishop slack setup [options] Create and install a Slack app, and save its credentials here Options: --name app name; defaults to the current directory name --display-name bot display name in Slack; defaults to --name --description short description shown in Slack --no-prompt don't prompt for anything left off --manual adopt an app you created in Slack yourself, using its tokens -h, --help display help for command ``` #### `bishop slack manifest` ``` Usage: bishop slack manifest [options] Print the app manifest, for creating an app in Slack by hand Options: --name app name; defaults to config or the directory name --display-name bot display name; defaults to --name --description short description shown in Slack -h, --help display help for command ``` ### `bishop teams` ``` Usage: bishop teams [options] [command] Microsoft Teams interface commands Options: -h, --help display help for command Commands: setup [options] Create a Teams app and save its credentials here, or check the one configured endpoint [options] Point the Teams app at a different URL, changing nothing else instructions [options] Print what to send whoever creates the Teams app, when that is an administrator help [command] display help for command ``` #### `bishop teams setup` ``` Usage: bishop teams setup [options] Create a Teams app and save its credentials here, or check the one configured Options: --name app name; defaults to the current directory name --display-name app name shown in Teams; defaults to --name --description short description shown in Teams --endpoint the URL Teams POSTs to; can be set later --app-id with --manual, the Teams app ID you were given --no-prompt don't prompt for anything left off --manual adopt an app somebody else created, using its credentials -h, --help display help for command ``` #### `bishop teams endpoint` ``` Usage: bishop teams endpoint [options] Point the Teams app at a different URL, changing nothing else Options: --app-id the Teams app to point; defaults to the one in config -h, --help display help for command ``` #### `bishop teams instructions` ``` Usage: bishop teams instructions [options] Print what to send whoever creates the Teams app, when that is an administrator Options: --endpoint the URL Teams should POST to, if you already know it -h, --help display help for command ```