https://github.com/announce/altogether
CLI tool to sync config files between Alfred and Albert
https://github.com/announce/altogether
albert alfred keyboard-launcher
Last synced: about 1 month ago
JSON representation
CLI tool to sync config files between Alfred and Albert
- Host: GitHub
- URL: https://github.com/announce/altogether
- Owner: announce
- License: apache-2.0
- Created: 2019-02-03T08:17:50.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-08T13:50:19.000Z (about 6 years ago)
- Last Synced: 2025-02-27T06:49:58.039Z (7 months ago)
- Topics: albert, alfred, keyboard-launcher
- Language: Go
- Homepage:
- Size: 8.83 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Altogether
===
[](https://dev.azure.com/announce/altogether/_build/latest?definitionId=4&branchName=master)
## Altogether in a Nutshell
Altogether is a CLI tool to synchronize configuration files between 2 major keyboard launchers -- [Alfred](https://www.alfredapp.com/) and [Albert](https://albertlauncher.github.io/).
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:
* [x] Web search
* [ ] Snippets (refer to [#13](https://github.com/announce/altogether/issues/13))
## Installation
#### For Mac users
Go ahead and grab Homebrewed `altogether`:
```bash
brew install announce/homebrew-altogether/altogether
```
#### For Arch Linux users
If you are using Arch Linux, [AUR Package](https://aur.archlinux.org/packages/altogether/) is recommended.
Install `altogether` with AUR helper such as `yay`:
```bash
yay -Syu altogether
```
#### How to get `altogether` command
Unless specified above, one of the simplest ways for your platform is:
1. Download package from [](https://github.com/announce/altogether/releases/latest) according to platform:
* macOS: `darwin-amd64.tar.gz`
* Linux: `linux-amd64.tar.gz`
1. Extract the compressed tarball and place `altogether` to somewhere under `PATH` directory:
```bash
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
There are 2 ways to specify arguments.
One is to use command options like below:
```bash
altogether sync-web --dry-run --alfred-path ~/.config/Alfred.alfredpreferences --albert-path ~/.config/testdata/albert
```
In the other way, you can specify 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
For instance, you can execute commands like as following:
```bash
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
```
#### Experimental: Systemd Configurations
Consider setting a Systemd configuration to run `altogether` automatically.
1. Place unit files to `~/.config/systemd/user/`
* You can find sample files under `sample/systemd/` in this repository
1. Register `altogether` and browse the logs like below:
```bash
systemctl --user daemon-reload && systemctl --user restart altogether
journalctl --user -xe -u altogether
```
## Supported Versions
[Alfred](https://www.alfredapp.com/changelog/):
* 3.8.x
[Albert](https://albertlauncher.github.io/docs/changelog/):
* 0.16.x
## Development Contribution
Here's how to get started!
1. Install [Docker](https://docs.docker.com/install/) (verified version: `18.09.1-ce`)
1. Build a container and start debugging:
```bash
./script/ci.sh init
./script/ci.sh ci
```
Related repositories:
* [announce/homebrew-altogether](https://github.com/announce/homebrew-altogether)
* [announce/aur-altogether](https://github.com/announce/aur-altogether)