Skip to main content
oi settings exposes the same configuration surfaces as the OpenIndex web UI. It is designed for human-owned credentials — Personal Access Tokens with read_write or admin scope. Workflow agent run tokens are intentionally rejected for all oi settings ... commands.
Do not use agent run tokens with oi settings. These commands require a PAT issued to a human user.
Because the settings surface is broad, the best way to discover available sub-commands is with --help:

​
Personal settings

Manage your profile, access tokens, calendar sources, and workflow preferences.

​
Domain settings

Manage domains, their workflows, members, and lifecycle.
delete-preview shows what would be removed before you commit to deleting a domain. Review the output carefully before proceeding with a destructive operation.

​
External settings

Manage mailboxes, email routing rules, email provider configuration, domains, and webhooks.

​
Admin settings

Instance-level administration: branding, invites, admin users, user management, and AI provider configuration.
Admin commands require a PAT with admin scope. Using a read_write-scoped token will result in a permission error.