fyora

The Faerie Queen, Fyora, is the ruler of Faerieland. She is a kind faerie who basically tries to keep everything under control, not just in Faerieland. (Neopets Wiki)

Fyora is a declarative replacement for GNU Stow. It is a symlink farm manager that uses a yaml file to declare which files/directories should be symlinked where, rather than a cli interface.

Installation

Using Go

If you have Go installed, you can install fyora with the following command:

go install github.com/wenbang24/fyora@latest

Pre-built binaries

You can download pre-built binaries for your platform from the releases page.

Then simply move the binary to a directory in your PATH, such as /usr/local/bin or ~/bin.

• Linux/macOS: chmod +x fyora, mv fyora /usr/local/bin
• Windows: Move fyora.exe to a directory in your PATH, such as C:\Windows\System32

Now open a terminal/command prompt and run fyora --version to see if it was installed correctly.

Building from source

1. Clone the repo
2. Run go mod tidy to install dependencies
3. Run go build to build the binary
4. Run go install to install the binary to your $GOPATH/bin directory

Usage

1. Create a config file (see below)
2. Run fyora
   1. By default, it will look for a file called fyora.yaml in your ~/.config directory. You can specify a different path using the --config flag (-c shorthand).

Config

(the important part)

The fyora config file is a yaml file that looks like this:

links:
    - type: outside
      source: /dir1
      target: ~/dir2
      unsafe: true
    - type: inside
      source: ~/dir3
      target: ~/dir/dir4
      unsafe: false
    - type: file
      source: /dir5/file.txt
      target: ~/dir2/dir/file.txt
      unsafe: false
ignore:
    - .DS_Store
    - .git

Outside links create a symlink to the folder itself i.e. ~/dir2/dir1 will point to to /dir1.

Inside links symlink everything inside the first folder to inside of the second folder i.e. ~/dir3/file.txt would be symlinked to ~/dir/dir4/file.txt.

File links symlink the file itself i.e. /dir5/file.txt would be symlinked to ~/dir2/dir/file.txt.

Unsafe mode is dangerous and should only be used if you know what you're doing. If unsafe mode is enabled and there is something at the target location, it will be deleted before the symlink is created, permanently deleting what was once there. This is useful for directories that may already exist but you want to replace with a symlink. This can also lead to irreversible data loss if you are not careful.

Everything under ignore (files and folders) will NOT be symlinked.

Where does the name come from?

"The Faerie Queen, Fyora, is the ruler of Faerieland. She is a kind faerie who basically tries to keep everything under control, not just in Faerieland." (Neopets Wiki)

My friend is a neopets fan and really wanted me to name it after Fyora. I thought it was a cute name and it stuck.