40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# Auto .file manager
|
|
Auto.s is a dotfile manager written in posix sh. It's main goal is to provide a
|
|
simple way to manage your dotfiles without leaving a footprint when it's done.
|
|
## How to
|
|
For information on arguments run: `auto. -h`
|
|
### topography
|
|
Auto.s uses a custom file format which is used to define what you want to do.
|
|
Currently the topography format supports 4 options which may be used like so:
|
|
```topography
|
|
# a comment
|
|
|
|
$$ echo "a shell command"
|
|
|
|
# copying files
|
|
filea -> fileb
|
|
|
|
# the copy command may also be prefixed with a # like so:
|
|
filea #-> fileb
|
|
# which will copy the file as root
|
|
|
|
# symbolically linking files
|
|
filea ~> fileb
|
|
|
|
# the link command may be prefixed just like the copy command
|
|
filea #~> fileb
|
|
|
|
# installing programs
|
|
:: neovim,firefox,neofetch
|
|
```
|
|
|
|
The main advantage of using the custom options over a simple shell script is the
|
|
ability to uninstall and install using just one line.
|
|
|
|
> [!Important]
|
|
> The `::` option is currently only supported on voidlinux, archlinux, and
|
|
> debian. If you would like to expand compatibility send [me](mailto:me@zacharyscheiman.com) a patch.
|
|
## Installing
|
|
Incase you wish to install this script on your computer a .topography file has
|
|
been provided, to install simply run `./auto. -i`
|