Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Configuration Files Reference

Quick reference for all nia configuration files, their purposes, and key fields.

File Overview

FileRequiredHierarchicalDescription
project.tomlYesNoProject metadata
agents.tomlNoYesAI agent configuration
toolchain.tomlNoYesDevelopment tools
commands.tomlNoYesWorkflow customization

project.toml

Defines project metadata used to provide context to AI agents.

Location: .nia/config/project.toml (repository only)

Key Fields:

FieldRequiredDescription
project.nameYesProject name
project.descriptionYesBrief description
project.languageYesPrimary language
project.frameworkYesFramework(s) used
project.testing_frameworkYesTesting framework
project.package_managerYesPackage manager
project.documentation_frameworkYesDocumentation tool

Related: Project Configuration

agents.toml

Configures AI agent selection and model preferences.

Location: .nia/config/agents.toml (supports hierarchical loading)

Key Fields:

FieldDescription
agent.defaultDefault AI agent
models.codeModel for code operations
models.docsModel for documentation

Related: Agent Setup, Model Selection

toolchain.toml

Defines development tools and platforms available in your environment.

Location: .nia/config/toolchain.toml (supports hierarchical loading)

Key Fields:

FieldDescription
issue_tracker.nameIssue tracking platform
code_platform.nameCode hosting platform
ticket_tracker.nameSupport ticket system
security_scanner.nameSAST platform

Related: Toolchain Configuration

commands.toml

Customizes workflow commands with context and prompt overrides.

Location: .nia/config/commands.toml (supports hierarchical loading)

Key Fields:

FieldDescription
workflows[].targetCommand target (code, issue, pr, etc.)
workflows[].contextTarget-level context files
workflows[].operationsOperation-specific settings

Related: Workflow Schema

Initialization

Create configuration files with:

# Full initialization with all options
nia config init --issues github_issues --code github --agent github_copilot

# Minimal initialization (uses external configs)
nia config init --minimal

Validation

Check configuration validity:

nia config validate

See Also