Configuration and storage

Glob keeps its server setting, account session and local store in separate places. Use the configuration commands to check what is saved and which server a command will use. Use --store or GLOB_STORE_DIR when you want to choose a different store directory.

Check your configuration#

glob config
glob server
glob status

glob config is short for glob config show. It displays the configuration file's location, its saved values, the effective server and the source of that server value. glob server is short for glob server show and displays only the effective server and its source.

glob status adds the CLI and protocol versions, selected store directory, whether a store file exists, and whether a session token is stored. It does not check the token with the server. Use the sign-in guide when your saved session is no longer accepted.

Add --json to a command when you need structured output:

glob config show --json
glob server show --json
glob status --json

The configuration result includes path, values, effective_server when configured, and server_source. The server result includes server when configured, and source. See output and exit codes for the envelope surrounding these results.

Set the server#

For the normal Glob service:

glob server set https://api.colli.dev
glob server show

This saves the address for later commands. You can make the same change through the general configuration command:

glob config set server https://api.colli.dev

Use an HTTPS base URL. An ordinary HTTP address is rejected; HTTP is accepted only for a server running on this computer. A URL must include its scheme and a host.

Override the server for one command#

A non-empty GLOB_SERVER_URL takes precedence over the saved server value:

GLOB_SERVER_URL=https://api.colli.dev glob server show

The override affects that command and does not rewrite the saved file. You can export the variable if you want later commands and the TUI to inherit it.

If glob server set succeeds but glob server show still displays a different address, check its source field. An exported GLOB_SERVER_URL continues to win after you change the saved value. To return to the saved server:

unset GLOB_SERVER_URL
glob server show

For ordinary account commands, precedence is environment, then saved configuration. The relay-node command also has an explicit --server option, which takes precedence over both. See the command reference.

With no server configured, the display reads not configured (local-only workspace). You can still use local note and task commands. Commands that need an account server stop with SERVER_NOT_CONFIGURED.

Configuration command reference#

Each of these commands accepts --json. The two set commands require their positional arguments; neither has a confirmation prompt. There is no config unset or server unset command.

Recognised keys#

For example, glob config set output json is accepted, but glob notes list still uses human-readable output. Use glob notes list --json when you need JSON.

An unknown key produces CONFIGURATION_FAILURE and lists output, server, workspace. An invalid output value produces output must be 'human' or 'json'. Both use exit code 7.

Where settings are saved#

glob config show gives you the exact file used by the current process. If the file does not exist, Glob treats it as an empty configuration. A set command creates its directory and saves the file.

Use this file for non-secret settings. Do not put a password, session token, API key or sync passphrase in it.

Edit or remove a saved value#

Use the commands for routine changes. To remove a saved value, open the path shown by glob config show in a text editor and remove its line.

The file uses a small, flat set of key = "value" lines:

# Glob CLI configuration
server = "https://api.colli.dev"

Use one setting per line, double-quoted simple values, and comments on their own lines. Avoid sections, nested settings and advanced TOML syntax. A later config set writes the saved values back in alphabetical order and replaces comments with its own introductory comment.

Choose a store directory#

By default the CLI uses ~/.glob/store. It uses its own store, separate from the Mac application's store. The TUI reads and writes through the CLI, so both interfaces use the same selected CLI store.

Commands that operate on stored data accept --store. For example:

glob notes list --store "$HOME/Glob Notes"
glob status --store "$HOME/Glob Notes"

For a default used by later commands and the TUI:

export GLOB_STORE_DIR="$HOME/Glob Notes"
glob status
glob-tui

The order is:

1. An explicit --store <directory> on a command that supports it.
2. A non-empty GLOB_STORE_DIR.
3. ~/.glob/store.

Quote paths containing spaces. The option and variable both expand a leading ~.

Choosing a directory does not move existing notes into it. If the directory has no store, commands that open stored data can create a new one there. glob status reports whether a store file already exists without creating one.

Changing the store also does not change the server setting or saved account session. Do not treat a different store directory as a different account. See moving notes with Markdown for the supported export and import commands.

On Linux the store file is knowledge.sqlite; on macOS it is GlobKit.store. The formats differ by platform. Use the CLI's commands to work with your data, and consult sync for its platform limits.

Session and sync inputs#

On macOS, the CLI keeps the saved session token in the login Keychain. On Linux, it uses ~/.glob/credentials. Set GLOB_CONFIG_DIR on Linux to choose another directory for the credentials file. Despite its name, this variable changes the session-token location only; it does not move config.toml or your store.

glob logout removes the saved CLI session. See sign in for the supported login methods.

For commands that require a sync passphrase, a non-empty GLOB_SYNC_PASSPHRASE takes precedence over --passphrase-stdin. If you want to supply a different passphrase on standard input, unset that environment variable first.

The TUI can remember its sync passphrase in ~/.glob/passphrase. It reads GLOB_SYNC_PASSPHRASE first, then that file. The Swift command does not read the TUI's remembered passphrase file: supply its passphrase through the environment or the supported standard-input option. See sync for examples.

Configure the terminal interface#

The TUI uses ~/.local/bin/glob by default. Set GLOB_BIN to an executable's full path when your installation is elsewhere:

GLOB_BIN="$HOME/bin/glob" glob-tui

GLOB_BIN chooses the command the TUI runs. It does not choose a store. The TUI does not search PATH for a different native command, so set this variable even when a custom installation's glob command works in your shell.

The interface uses the inherited server and store variables. You do not pass --store to bare glob to open the TUI; set GLOB_STORE_DIR before launching it.

For browser sign-in, GLOB_ACCOUNT_URL changes the account portal address; glob login --web --portal <url> takes precedence. Ordinary users can leave both unset to use the normal account portal.

If the terminal type is unknown, the installed launcher and the TUI try xterm-256color. See troubleshooting if the interface still cannot start or draw correctly.

Configuration errors#

Read troubleshooting for authentication, store and network failures.