Altogether
Altogether in a Nutshell
Altogether is a CLI tool to synchronize configuration files between 2 major keyboard launchers -- Alfred and Albert.
So the target user is who adopts both Mac and Linux on a daily basis, or someone needs to migrate one's config to the another.
Available Features
Supported configuration files are the ones relating to:
Installation
For Mac users
Go ahead and grab Homebrewed altogether
:
brew install announce/homebrew-altogether/altogether
For Arch Linux users
If you are using Arch Linux, AUR Package is recommended.
Install altogether
with AUR helper such as yay
:
yay -Syu altogether
How to get altogether
command
Unless specified above, one of the simplest ways for your platform is:
- Download package from according to platform:
- macOS:
darwin-amd64.tar.gz
- Linux:
linux-amd64.tar.gz
- Extract the compressed tarball and place
altogether
to somewhere under PATH
directory:
curl -L https://github.com/announce/altogether/releases/download/v0.1.2/linux-amd64.tar.gz | tar -zxvf - \
&& mv ./linux-amd64/altogether /usr/local/bin \
&& altogether --help
Usage
Command Arguments
Specify required parameters in environmental variables:
AL2_ALFRED_PATH
: a path to Alfred's config directory
AL2_ALBERT_PATH
: a path to Albert's config directory
AL2_DRY_RUN
: set 1
to dump merged configurations in TSV style without actual file change
AL2_VERBOSE
: set 1
to print out detailed logs
You can execute commands like as following:
export AL2_ALFRED_PATH="${HOME}/.config/Alfred.alfredpreferences"
export AL2_ALBERT_PATH="${HOME}/.config/albert"
export AL2_DRY_RUN=1
export AL2_VERBOSE=1
./altogether sync-web
Or, you also can specify command options like below:
altogether sync-web --dry-run --alfred-path ~/.config/Alfred.alfredpreferences --albert-path ~/.config/testdata/albert
TBD: Systemd Configurations
Consider set up Systemd configuration if you want to automatically sync configurations.
- Place unit files to
~/.config/systemd/user/
. Sample systemd configuration files are available under ./sample
.
- Run commands like below to test:
systemctl --user daemon-reload && systemctl --user restart altogether
journalctl --user -xe -u altogether
Supported Versions
Alfred:
Albert:
Contribution
Here's how to get started!
- Install Docker (verified version:
18.09.1-ce
)
- Build a container and start debugging:
./script/ci.sh init
./script/ci.sh ci
Related repositories: