Burner CLI Documentation

Welcome to the Burner CLI documentation. Burner is a command-line tool designed to help developers quickly create, manage, and clean up temporary development projects.

Current Version: ... | Requires: .NET 10.0 or later

What is Burner?

Burner is the home for your experimental projects. Whether you're testing a new library, prototyping an idea, or following a tutorial, Burner helps you:

Quickly scaffold projects using predefined or custom templates
Keep organized with all projects in a unified directory
Track project age with automatic YYMMDD-NAME naming
Clean up automatically when experiments get old
Import existing projects into your burner home

Quick Installation

# Install globally via .NET
dotnet tool install -g Burner-CLI
# Verify installation
burner --version

Core Concepts

Projects

Every burner project lives in the burnerHome directory (default: ~/.burner/projects). Projects are named with a date prefix: YYMMDD-projectname to track when they were created.

Templates

Templates are scripts that set up new projects. Burner includes built-in templates for common project types and supports custom templates written in PowerShell, Bash, Python, or any executable.

Auto-Cleanup

By default, Burner can automatically identify and remove projects older than a configurable number of days. This keeps your disk tidy without manual intervention.

Built-in Templates

Template	Description
`dotnet`	.NET Console Application
`web`	HTML + JavaScript + CSS Web App

See Custom Templates to learn how to create your own templates.

Command Overview

Command	Description
`burner new`	Create a new project from a template
`burner list`	List all burner projects
`burner burn`	Delete projects (cleanup)
`burner open`	Open a project directory
`burner import`	Import existing folder as a burner project
`burner config`	View and update configuration
`burner templates`	List available templates
`burner stats`	Show project statistics

Next Steps

Installation Guide - Detailed installation instructions
Quick Start Tutorial - Create your first project
Custom Templates - Extend Burner with your own templates
API Reference - Explore the codebase