Shortcuts For Initialization

Book Project Init Shortcuts

This page covers commands for setting up and maintaining your book project structure.

All initialization commands are provided by the manuscripta library.

---

Makefile Targets (recommended)

# Full setup: install dependencies + run initializer
make setup

# Initialize project structure (runs lock-install first)
make init-bp

# Alias
make init-project

# Just install dependencies
make lock-install

---

Poetry Commands

If you prefer using Poetry directly:

# Initialize project structure
poetry run init-bp

# With --clean flag to remove excluded items
poetry run init-bp --clean

---

Overview

Makefile Target	Poetry Command	Description
make setup	poetry lock && poetry install && poetry run init-bp	Full setup with dependency installation
make init-bp	poetry run init-bp	Initialize book project structure
make init-project	poetry run init-bp	Alias for init-bp
make lock-install	poetry lock && poetry install	Lock and install dependencies

---

What init-bp Does

• Prompts for project name, description, book title, author, year, language
• Creates all directories and files defined in config/init-settings.yaml
• Writes config/metadata.yaml with your input
• Updates pyproject.toml with project name and description
• Creates config/init-settings.yaml on first run (for future customization)
• Logs every action (created / already exists) with a summary

The initializer is idempotent and safe to re-run.

---

Customization

Edit config/init-settings.yaml to control which directories and files are created. See the Project Initialization page for full documentation on include_directories, include_files, exclude, and the --clean flag.

---

Related

• Project Initialization - Full documentation with config examples
• Generate Project Structure - Directory layout overview
• Makefile Overview - All available make targets

---