tori/README.md
2024-07-12 08:17:34 -03:00

42 lines
1.3 KiB
Markdown

# tori
tori is a tool to track your personal systems' configurations and replicate them.
If you'd like a more detailed description of what it is, its purpose, origins and goals, see the [announcement blog post](https://blog.jutty.dev/posts/introducing-tori.html).
Refer to the [project website](https://tori.jutty.dev) for updates and access to [documentation](https://tori.jutty.dev/docs).
## Installation
As it is still in very early development, tori is not yet packaged.
If you want to try it, you can clone its repository to your system:
```sh
git clone https://brew.bsd.cafe/jutty/tori.git /path/to/repository
```
Next, create `~/.config/tori/tori.conf` with the following content:
```conf
tori_root = /path/to/repository
```
If you clone it to the default location, `~/.local/share/tori`, the above step is not necessary.
Finally, you need to symlink the `tori` file at the repository root to somewhere on your `$PATH`:
```
ln -s /path/to/repository/tori $HOME/.local/bin/tori
```
## Usage
Currently, the following commands are implemented:
- `check`: check for divergences between the configuration and the system
- `cache`: force an update of the local package cache
- `help`: show a usage summary with supported options
- `version`: print the current version and its release date
To issue a command, use `tori <command>`, as in `tori check`.