GitPanda v3.1.1 Install
Reference

Configuration

Where gitpanda keeps its settings, every environment variable, and how to use several servers or accounts.

gitpanda has no settings file to edit by hand. Everything is set by commands (login, use, shell) or environment variables.

Files#

Path What's in it
~/.gitpanda/config.json Your server, one key per connected company, and your default. Readable only by you (mode 600).
~/.gitpanda/clones.json Where you've cloned each repository, so repos can show it.
~/.gitpanda/update.json When gitpanda last checked for a new version (once a day) and the result.
<clone>/.gitpanda/state.json The clone's bookkeeping: each file's server version and hash, the staging area, and unpushed commits.
<clone>/.gitpanda/objects/ Copies of pulled, staged and committed versions, used by diff, restore and push.

Don't edit the .gitpanda folders by hand. If a clone's state gets confused, clone again.

Environment variables#

Variable What it does
GITPANDA_KEY Use this API key for every command, instead of the saved sign-ins.
GITPANDA_HOST Use another OkayPanda server. Default: https://okaypanda.com.
GITPANDA_HOME Keep settings in another folder instead of ~/.gitpanda.
GITPANDA_ASCII=1 Show (o.o) instead of the 🐼 emoji.
GITPANDA_NO_UPDATE=1 Never check for new versions.
GITPANDA_INSTALL_DIR Where the installer puts gitpanda (default ~/.local/bin).
GITPANDA_VERSION The version the installer installs (default: the latest).
GITPANDA_SITE Where the installer downloads from (default https://gitpanda.ai).
NO_COLOR=1 No colors.
FORCE_COLOR=1 Colors even when output isn't a terminal (for logs and previews).

Which key is used#

For each command, gitpanda picks a key in this order:

  1. GITPANDA_KEY, if set;
  2. the company you named (gitpanda clone <repo>);
  3. the company of the clone you're in;
  4. your default (gitpanda use <repo>), or the first company you connected.

Several servers or accounts#

Settings are per GITPANDA_HOME, so keep separate folders:

alias gp-staging='GITPANDA_HOME=~/.gitpanda-staging GITPANDA_HOST=https://staging.okaypanda.pages.dev gitpanda'
gp-staging login
gp-staging repos

The same works for two different OkayPanda accounts on one computer.

Colors and width#

gitpanda uses colors when its output is a terminal and NO_COLOR isn't set. It uses 256-color codes that every modern terminal supports. Long lines wrap naturally; nothing depends on terminal width.