Shell Aliases

To streamline repetitive tasks, shell aliases are available for common command line actions. These aliases can be located and modified in the .fjell file.

Adding aliases to the shell

To utilize aliases, they must be sourced in active shell sessions. Adding the following line to the end of your .bashrc, .zshrc, etc., will load them upon session initialization (provided they are stored in the correct location):

[ -f /homeserver/.fjell ] && source /homeserver/.fjell

Docker wrapper

The command fjell <command> serves as a wrapper to simplify frequently used Docker commands. Below are some straightforward commands:

Alias	Action
fjell ps	List all containers
fjell start $C1 $C2 ...	Start container $C1 $C2 ...
fjell stop $C1 $C2 ...	Stop container $C1 $C2 ...
fjell rm $C1 $C2 ...	Remove container $C1 $C2 ...
fjell restart $C1 $C2 ...	Restart container $C1 $C2 ...

The most useful commands, up and down pertain to Docker Compose. They initiate or terminate entire stacks, assuming the individual stacks are defined in /homeserver/$STACK_NAME/docker-compose.yaml.

Alias	Action
fjell up $S1 $S2 ...	Starts stacks $S1, $S2, ...
fjell down $S1 $S2 ...	Stops stacks $S1, $S2, ...

Other miscellaneous commands are available.

Alias	Action
fjell ip	Lists servers local and public IP address
fjell logs $CONTAINER	Shows the running logs of the container
fjell shell $CONTAINER	Attaches a shell to the container