latex-forge 0.2.0

CLI for creating standalone LaTeX projects from this toolbox.

LaTeX Toolbox

Skip the setup. Start writing. Everything you need, nothing more.

Lire en français

---

LaTeX Toolbox is a command-line tool that generates ready-to-compile, standalone LaTeX projects from templates. Each generated project embeds its own styles and assets — it can be compiled, shared, and versioned independently, with no dependency on this repository.

Installation

pipx install latex-forge

Requires Python 3.10+. If pipx is not installed: brew install pipx on macOS, or see pipx.pypa.io.

First setup

On a fresh machine, run the setup command to check your environment and install LaTeX automatically:

latex-forge setup

This verifies that latexmk and lualatex are available, and offers to install them via your system package manager (brew on macOS, apt on Debian/Ubuntu, winget on Windows). VS Code extensions are also installed if the code CLI is available.

Profile

Set up your profile once to automatically pre-fill project metadata on every create:

latex-forge profile --set

Full name: Dupont Alice
University / school: Université de Bordeaux
Program / formation: Master Informatique
GitHub username (optional): dupont-alice

This is offered automatically on first launch. To update it at any time:

latex-forge profile        # view current profile
latex-forge profile --set  # update

Profile values are stored in ~/.latex-forge.toml and applied to each new project's frontmatter/metadata.tex. When a GitHub username is set, it is rendered as a link under your name in the PDF title page.

Shell completion

Tab completion for commands, flags, and template names. Add one line to your shell config:

bash (~/.bashrc) or zsh (~/.zshrc):

eval "$(latex-forge completion)"

Reload your shell (source ~/.zshrc) or open a new terminal window.

Configuration

Create ~/.latex-forge.toml to set default values applied to every command:

default_template = "rapport-projet-en"
default_output_dir = "~/Documents/projects"

Key	Description
default_template	Template used when --template is omitted
default_output_dir	Output directory used when --output is omitted

Usage

Interactive mode

Run create with no arguments to be guided step by step:

$ latex-forge create

Project name: my-report
Available templates:
  1. cv-en
  2. cv-fr
  3. rapport-projet-en
  4. rapport-projet-fr
  5. research
Choose a template [1-5]: 3
Create project in [/Users/thomas/Desktop]:

Project created: /Users/thomas/Desktop/my-report
Edit: my-report/my-report.tex
Next: fill in frontmatter/metadata.tex then save to compile.
Open project in VS Code? [y/N]

With flags

All arguments are optional — omitted ones are prompted interactively.

# specify everything upfront
latex-forge create --name my-report --template rapport-projet-en

# create in a specific directory
latex-forge create --name my-paper --template research --output ~/Desktop

Rename a project

# from the parent directory
latex-forge rename old-name new-name

# from inside the project directory
latex-forge rename new-name

This renames the folder, the main .tex file, and any existing build artifacts.

Available templates

Template	Language	Description
rapport-projet-en	English	ISO/IEEE-aligned project report — requirements, architecture, testing, bibliography, appendices
rapport-projet-fr	French	AFNOR/ISO-aligned project report — cahier des charges, architecture, tests, bibliographie, annexes
research	English	Research article — two-column layout, related work, methodology, experiments, bibliography
cv-en	English	CV / résumé — education, experience, projects, involvement, skills
cv-fr	French	CV — formation, expérience, projets, engagement, compétences

latex-forge list-templates

After creating a project

1. Open the generated folder in VS Code.
2. Fill in frontmatter/metadata.tex — title, authors, course name, university logo.
3. Save the main .tex file to trigger compilation (requires LaTeX Workshop).
4. The PDF is built into build/.

Example metadata.tex:

\newcommand{\reporttitle}{Audio Fingerprinting Study}
\newcommand{\coursename}{Machine Learning}

\resetauthors
\addauthor{Alice Martin}{}
\addauthor{Bob Durand}{}

\resetteachers
\addteacher{Dr Example}{}

\resetprojectlinks
\addprojectlink{Repository}{https://github.com/example/project}

Leaving the second argument empty in \addauthor{...}{} or \addteacher{...}{} hides the role label.

Generated project structure

my-project/
├── my-project.tex            ← main file (named after the project)
├── frontmatter/
│   ├── metadata.tex          ← title, authors, course
│   └── toc.tex
├── sections/
├── backmatter/
├── figures/
├── images/
├── screens/
├── assets/
│   ├── images/common/
│   └── logos/
├── styles/packages/          ← embedded styles, no external dependency
├── scripts/                  ← standalone setup scripts
├── .vscode/                  ← LaTeX Workshop settings
└── .gitignore

Styles and logos are copied into the project at creation time. The generated project has no runtime dependency on this repository.

Command reference

Command	Description
latex-forge create	Create a project (interactive)
latex-forge create --name NAME --template TEMPLATE	Create with explicit arguments
latex-forge create --output DIR	Set output directory
latex-forge rename OLD NEW	Rename from parent directory
latex-forge rename NEW	Rename from inside project directory
latex-forge list-templates	List available templates
latex-forge setup	Check and set up the LaTeX environment
latex-forge setup --check-only	Check without installing anything
latex-forge setup --install-tex	Install LaTeX directly
latex-forge --version	Show installed version
latex-forge profile	View your saved profile
latex-forge profile --set	Run interactive profile setup
latex-forge completion	Print shell completion setup code

Versioning generated projects

Each generated project is self-contained, making it straightforward to version independently:

cd my-project
git init
git add .
git commit -m "Initial report"

Create a dedicated private repository and invite only the collaborators relevant to that document.

Contributing

See CONTRIBUTING.md.

---

Made by thmsgo18