Skip to Content
FeaturesSettings

Settings

Project-level configuration settings let you store and manage key-value pairs that control how your project behaves. Use settings for feature flags, configuration values, and shared constants.

Overview

Settings are project-scoped key-value pairs that you can read and write from the admin dashboard or the CLI. They provide a centralized place to manage configuration without redeploying code. Settings are an admin/operator surface — they are not exposed on the public GraphQL API.

Each setting has:

PropertyDescription
keyUnique identifier for the setting (e.g., site.title)
valueThe setting value (string, number, boolean, or JSON)
descriptionOptional description of what the setting controls

Settings are useful for configuration that needs to change without a code deploy.

In the Admin

Viewing Settings

  1. Navigate to Settings > Project Settings > Configuration
  2. Browse all settings for your project
  3. Use the search bar to find specific settings by key

Creating a Setting

  1. Click Add Setting
  2. Enter a key (use dot notation for organization, e.g., site.title)
  3. Enter the value
  4. Optionally add a description
  5. Click Save

Editing a Setting

  1. Find the setting in the list
  2. Click Edit
  3. Update the value
  4. Click Save

Deleting a Setting

  1. Find the setting in the list
  2. Click Delete
  3. Confirm the deletion

Via the CLI

Settings take a positional key and value. New keys require a --category; an optional --data-type declares how the value is parsed.

# List all settings (optionally filter by category)
foir settings list
foir settings list --category site
 
# Get a specific setting by key
foir settings get site.title
 
# Set a value (creates or updates). --category is required for a new key.
foir settings set site.title "My Project" --category site
 
# Set a typed value
foir settings set features.flags '{"newCheckout":true,"darkMode":false}' \
  --category features --data-type JSON
 
# Reset a setting back to its default / remove it
foir settings reset site.title

Common Settings Examples

KeyExample ValueUse Case
site.title"My Store"Display name for the site
site.description"The best online store"Meta description
features.maintenancetrueToggle maintenance mode
features.newCheckoutfalseFeature flag for gradual rollout
seo.defaultImage"https://..."Default social sharing image
integrations.analytics.id"GA-12345"Third-party integration config

Best Practices

  • Use dot notation for keys to organize settings into logical groups (e.g., site.title, site.description, features.darkMode).
  • Add descriptions to every setting so team members understand what each one controls.
  • Use settings for runtime configuration that may need to change without a code deploy — feature flags, display values, integration parameters.
  • Do not store secrets in settings — use environment variables or API keys for sensitive values. Settings are readable by anyone with project access.
  • Keep values simple — prefer primitive values (strings, numbers, booleans) over deeply nested JSON when possible.
Last updated on
Team MembersDesign Tokens