Funky takes shell functions to the next level by making them easier to define, more flexible, and more interactive.
Table of Contents
- Similar Projects
Funks are manipulated using the
gfunky commands. These commands have the same user interface, which is specified in the Command-line Interface section. The difference between the two commands is treated in the Local vs Global section.
Local vs Global
Local funks are stored using a hidden database file that is located in the same directory where the funk was created. These can be manipulated using the action command options described above. Once created, a local funk can be used just like any other command or normal funk---as long as you have activated the provided shell extension (see Additional Install Steps) and are inside of the directory where the local funk was originally defined.
Global funks, on the other hand, are stored in your home directory (
/home/<user>) and can
be used from any directory. Local funks can be used to override global funk definitions.
Local and global funks can be manipulated (created, removed, edited, renamed, etc.) by using the
gfunky commands, respectively.
Funk Definition Shortcuts
Normally when defining a funk, the provided raw definition (the final contents of the temp file) is inserted directly into the generated function definition. However, funky does try to make some alterations to the original funk definition when doing so is convenient. These funky definition shortcuts can make defining funks faster:
A funk definition of the form
@./relative/path/to/directory will be automatically changed to
cd /absolute/path/to/directory/"$@" || return 1
Simulate Shell Variables
A funk definition of the form
"Some string here..." will be automatically changed to
echo "Some string here..." "$@"
This allows you to use funks to simulate shell variables via command substitution.
The "$@" Special Parameter
This project originally used aliases. The decision to migrate to shell functions was made based on the fact that shell functions are far more capable than aliases. Moreover, there is very little benefit to using aliases over shell functions.
With that said, actual aliases do have one appeal over shell functions. When you use an alias, any
arguments that you pass to it are automatically passed to the command definition (at runtime,
aliases are just substituted with their definitions). For the purpose of emulating this behavior
when it would typically be desired, a funk defined using a single-line command definition
that does NOT already contain argument variables (e.g. does not contain
$@) will automatically have the
"$@" special parameter appended to its
definition. This allows for the same automatic argument handling that you would expect from an
See the official Bash docs for more information on Bash's special parameters.
pip to Install
To install funky, run this command in your terminal:
$ pip install pyfunky
This is the preferred method to install funky, as it will always install the most recent stable release.
Building from Source
You can either clone the public repository:
$ git clone git://github.com/bbugyi200/funky
Or download the tarball:
$ curl -OL https://github.com/bbugyi200/funky/tarball/master
Once you have a copy of the source, you can install funky by running:
Additional Installation Steps
For the best experience, funky needs to be integrated into your shell environment using the provided shell script.
A shell script by the name of
funky.sh should have been copied to
during the installation process (it can also be found here). You can integrate funky into your shell by sourcing the
funky.sh script into your shell's configuration file. Assuming the script was copied to
~/.local/share/funky/funky.sh (its default location), for example, you would add the following line to your
[ -f ~/.local/share/funky/funky.sh ] && source ~/.local/share/funky/funky.sh
If you install funky with root permissions, the
funky.sh script will instead be installed to
- desk - A lightweight workspace manager for the shell
- smartcd - Alter your bash (or zsh) environment as you cd
Pull requests are welcome. See CONTRIBUTING.md for more information.