Skip to main content

nut init

Initialize Coconut in the current repository.
nut init [options]

Overview

The init command sets up the necessary configuration files and directory structure for Coconut in your project. This is the first command you should run when starting to use Coconut in a new repository.

What It Does

When you run nut init, Coconut will:
  • Create a .nut directory in your repository root
  • Generate default configuration files
  • Set up the schema reference files
  • Initialize the proposal tracking system
  • Configure the local Coconut instance

Usage

Basic initialization:
nut init
Options:
  • --name <name> - Repository name
  • --description <description> - Repository description
  • --id <id> - Coconut instance ID (for non-interactive use)
  • --force - Force initialization even if already initialized
Examples:
# Interactive initialization (prompts for details)
nut init

# Initialize with specific name
nut init --name "My Project"

# Initialize with name and description
nut init --name "My Project" --description "A web application"

# Force re-initialization
nut init --force

# Non-interactive initialization with instance ID
nut init --id coconut-123456 --name "Project" --description "Description"

Next Steps

After initializing Coconut, you can:
Run nut init in the root directory of your repository for best results.