Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
Update Command Guide
Browse files Browse the repository at this point in the history
Co-Authored-By: aayush <[email protected]>
Co-Authored-By: Smriti Bhandari <[email protected]>
  • Loading branch information
3 people committed Dec 29, 2024
1 parent 19ddcdc commit fdfa8b6
Showing 1 changed file with 34 additions and 14 deletions.
48 changes: 34 additions & 14 deletions docs/installation/cmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,39 @@ Usage: carch [OPTIONS]
A tool for automating Arch Linux setups.

Options:
--help Show this help message and exit.
--version Show the program version.
--run-script <name> Run the specified script from /usr/bin/scripts.
--list-scripts List all available scripts in /usr/bin/scripts.
--update Update Carch using the latest script.
--gtk Launch the GTK interface.
--uninstall Uninstall Carch and remove all associated files.
--help, -h Show this help message and exit.
--version, -v Show the program version.
--gen-config Generate a default configuration file in ~/.config/carch/carch.conf.
--config <conf dir> Use a specific configuration file to load selected scripts.
-c Use the default configuration file to load selected scripts.
--run-script <name>, -r Run the specified script from /usr/bin/scripts.
--list-scripts, -l List all available scripts in /usr/bin/scripts.
--update Update Carch using the latest script.
--gtk, -g Launch the GTK interface.
--uninstall Uninstall Carch and remove all associated files.
```
:::

- `--help, -h` *Show this help message and exit.*
- `--version, -v` *Show the program version.*
- `--gen-config` *Generate a default configuration file in ~/.config/carch/carch.conf.*
- `--config <conf dir>` *Use a specific configuration file to load selected scripts.*
- `-c` *Use the default configuration file to load selected scripts.*
- `--run-script <name>, -r` *Run the specified script from /usr/bin/scripts.*
- `--list-scripts, -l` *List all available scripts in /usr/bin/scripts.*
- `--update` *Update Carch using the latest script.*
- `--gtk, -g` *Launch the GTK interface.*
- `--uninstall` *Uninstall Carch and remove all associated files.*

Example config:
```conf
# Carch Conf File Example
# List the script names (without .sh extension) you want to include in the menu.
# Example:
Alacritty
Kitty
```

- `--help` *Displays the help message.*
- `--update` *Updates Carch to the latest script version.*
- `--version` *Shows the current version of Carch.*
- `--run-script <name>` *Executes the specified script.*
- `--list-scripts` *Lists all available scripts.*
- `--gtk` *Launch the GTK interface.*
- `--uninstall` *Uninstalls Carch and removes all associated files.*
```sh
carch --config /path/to/config.conf
```

0 comments on commit fdfa8b6

Please sign in to comment.