FlintNUU Flint Docs
Reference

Configuration Reference

Complete guide to Flint configuration files and options.

Configuration Files Overview

FileLocationPurposeEdit
flint.tomlFlint rootWorkspace configurationYes
flint.lock.flint/Installed state trackingNo
mesh.config.yaml.flint/Mesh indexing metadataNo
config.toml~/.flint/Global user settingsYes
registry.json~/.flint/Global Flint registryNo

flint.toml

The main configuration file for your Flint workspace. Located at the root of your Flint.

Complete Structure

[flint]
name = "my-project"
type = "flint"

[plugins]
required = [
  "core",
  "living-documents",
  "increments",
  "projects",
]

[mods]
required = [
  "claude-code",
]

[workspace]
references = [
  { name = "monorepo", type = "codebase" },
  { name = "design-docs", type = "drive" },
]

[imports]
required = [
  "NUU Flint/Guide",
]

[flint] Section

Core workspace identity.

[flint]
name = "my-project"
type = "flint"
FieldRequiredValuesDescription
nameYesstringUnique identifier, typically matches folder name
typeYesflintWorkspace type

The name field is used:

  • As the display name in flint list
  • In import references from other Flints

[plugins] Section

Declare plugins to install in this workspace.

[plugins]
required = [
  "core",
  "living-documents",
  "increments",
  "projects",
  "notepad",
  "plan",
]

Plugins are specified by kebab-case name. Run flint plugin list --available to see all plugins.

Core plugins:

  • core - Base conventions and agent setup
  • living-documents - Document lifecycle tracking
  • increments - Version stream management
  • projects - Task and backlog management
  • notepad - Quick capture and brainstorming
  • plan - High-level planning

[mods] Section

Declare mods (integrations) to install.

[mods]
required = [
  "claude-code",
]

Available mods:

  • claude-code - Claude Code integration with CLAUDE.md generation

[workspace] Section

Declare external resource references. These are portable declarations of what external resources the workspace connects to.

[workspace]
references = [
  { name = "monorepo", type = "codebase" },
  { name = "design-docs", type = "drive" },
  { name = "api", type = "api" },
]
FieldRequiredDescription
nameYesReference identifier (creates Workspace/References/rf-<name>.md)
typeYesResource type

Reference types:

  • codebase - Source code repository
  • drive - File system directory
  • api - External API
  • database - Database connection
  • service - External service

Machine-specific paths are stored in .flint/workspace.toml (gitignored), not in flint.toml.

[imports] Section

Import exports from other registered Flints.

[imports]
required = [
  "NUU Flint/Guide",
  "NUU Parse/API Docs",
]

Format: "<Flint Name>/<Export Name>"

The source Flint must be registered and have the specified export configured.


flint.lock

Generated lock file tracking installed state. Located at .flint/flint.lock. Do not edit manually.

Structure

version: 1
flintVersion: 1.0.0
created: 2026-01-04T10:30:05.953Z
synced: 2026-01-04T10:30:05.953Z
plugins:
  - name: living-documents
    version: 1.0.0
    installedAt: 2026-01-04T09:00:00.000Z
mods:
  - name: claude-code
    version: 1.0.0
    installedAt: 2026-01-04T10:30:05.953Z
FieldDescription
versionLock file format version
flintVersionFlint CLI version that created/synced
createdWhen the lock file was created
syncedLast sync timestamp
pluginsArray of installed plugins
modsArray of installed mods

Plugin/Mod Entry

- name: living-documents
  version: 1.0.0
  installedAt: 2026-01-04T09:00:00.000Z
FieldDescription
nameKebab-case identifier
versionInstalled version
installedAtInstallation timestamp

The lock file is regenerated by flint sync.


mesh.config.yaml

Mesh indexing configuration. Located at .flint/mesh.config.yaml. Do not edit manually.

Structure

version: 1
id: a8f63611-9af9-4bd5-9c73-84d22fdfb201
type: flint
created: 2026-01-04T10:30:05.856Z
FieldDescription
versionConfig format version
idUUID for this mesh
typeMesh type (flint)
createdCreation timestamp

This file is created during flint init and should not be modified.


Global Configuration

User-wide settings stored at ~/.flint/config.toml.

Structure

mode = "production"

Settings

SettingDefaultDescription
modeproductionFeature mode

Feature Mode

Controls which features are available:

ModeDescription
productionStable features only (default)
experimentalInclude experimental features
devAll features including development

Manage with the flint mode command (see below).

flint config Command

View and modify global configuration.

# View all config
flint config

# Get a specific value
flint config get mode

# Set a value
flint config set mode production

flint mode Command

Manage feature mode with better UX than direct config editing.

# Show current mode
flint mode

# Set mode
flint mode production
flint mode experimental
flint mode dev

# List all features and availability
flint mode --list

# Reset to default
flint mode --reset

Global Registry

Registry of all Flints on this machine. Located at ~/.flint/registry.json. Managed by CLI commands.

Structure

{
  "version": 1,
  "flints": [
    {
      "name": "NUU Flint",
      "path": "/Users/nathan/dev/nuu/nuu-flints/(Flint) NUU Flint",
      "type": "flint",
      "source": "local",
      "exports": ["Guide"]
    }
  ]
}

Flint Entry Fields

FieldRequiredDescription
nameYesFlint name (from flint.toml)
pathYesAbsolute path to Flint
typeNoWorkspace type
sourceNoCurrently always local
exportsNoArray of export names

Managing the Registry

# List registered Flints
flint list

# Register current directory
flint register

# Register specific path
flint register /path/to/flint

# Unregister
flint unregister

Configuration Patterns

Minimal Flint

[flint]
name = "notes"
type = "flint"

Software Project

[flint]
name = "my-app"
type = "flint"

[plugins]
required = [
  "core",
  "living-documents",
  "increments",
  "projects",
  "plan",
]

[mods]
required = [
  "claude-code",
]

[workspace]
references = [
  { name = "repo", type = "codebase" },
]

Research/Notes

[flint]
name = "research"
type = "flint"

[plugins]
required = [
  "core",
  "living-documents",
  "notepad",
]

File Locations Summary

FileLocationGit
flint.toml<flint>/Committed
.flint/flint.lock<flint>/.flint/Gitignored
.flint/mesh.config.yaml<flint>/.flint/Gitignored
.flint/workspace.toml<flint>/.flint/Gitignored
~/.flint/config.tomlHome directoryN/A
~/.flint/registry.jsonHome directoryN/A