From 66f65f8027febfd6e1a9a51fd971e1dc9c4b5a3c Mon Sep 17 00:00:00 2001 From: Evan Doyle Date: Fri, 7 Feb 2025 17:20:35 -0800 Subject: [PATCH] Brief explanation of tach init in docs --- docs/usage/commands.mdx | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/usage/commands.mdx b/docs/usage/commands.mdx index 1615d200..5ab09d2f 100644 --- a/docs/usage/commands.mdx +++ b/docs/usage/commands.mdx @@ -2,9 +2,26 @@ title: Commands --- +## tach init + +Tach provides a guided setup process in `tach init`. This command will provide guidance and perform validation, +while walking through `tach mod`, `tach sync` and `tach show`. + +New users should start with this command. + +```bash +usage: tach init [-h] [--force] + +Initialize a new project + +options: + -h, --help show this help message and exit + --force Force re-initialization if project is already configured. +``` + ## tach mod -Tach comes bundled with a command to set up your initial boundaries - `tach mod`. +Tach provides an interactive editor for configuring your module boundaries - `tach mod`. ```bash usage: tach mod [-h] [-d [DEPTH]] [-e file_or_path,...]