docs: add documentation and sync script
- CLAUDE.md: guidance for Claude Code AI - README.md: repository overview and structure - QUICKSTART.md: setup and usage guide - SUMMARY.md: inventory of workflows and snippets - alfred-sync.sh: git sync script for Alfred preferences Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
79
QUICKSTART.md
Normal file
79
QUICKSTART.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# Quick Start
|
||||
|
||||
Get your Alfred preferences synced in a few steps.
|
||||
|
||||
## Initial Setup
|
||||
|
||||
### 1. Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone <your-repo-url> ~/Sync/AlfredPrefs
|
||||
cd ~/Sync/AlfredPrefs
|
||||
```
|
||||
|
||||
### 2. Link Alfred Preferences
|
||||
|
||||
Replace Alfred's default preferences with a symlink to this repository:
|
||||
|
||||
```bash
|
||||
# Backup existing preferences first (if they exist)
|
||||
mv ~/Library/Application\ Support/Alfred/Alfred.alfredpreferences \
|
||||
~/Library/Application\ Support/Alfred/Alfred.alfredpreferences.backup
|
||||
|
||||
# Create the symlink
|
||||
ln -s ~/Sync/AlfredPrefs/Alfred.alfredpreferences \
|
||||
~/Library/Application\ Support/Alfred/Alfred.alfredpreferences
|
||||
```
|
||||
|
||||
### 3. Restart Alfred
|
||||
|
||||
Quit and relaunch Alfred. Your workflows and snippets will now be loaded from this repository.
|
||||
|
||||
## Daily Usage
|
||||
|
||||
### Sync Your Changes
|
||||
|
||||
After modifying workflows or snippets in Alfred:
|
||||
|
||||
```bash
|
||||
cd ~/Sync/AlfredPrefs
|
||||
./alfred-sync.sh
|
||||
```
|
||||
|
||||
That's it! Your changes are now committed and pushed.
|
||||
|
||||
### Pull Changes from Another Machine
|
||||
|
||||
```bash
|
||||
cd ~/Sync/AlfredPrefs
|
||||
git pull
|
||||
```
|
||||
|
||||
Then restart Alfred to load the updated preferences.
|
||||
|
||||
## Sync Script
|
||||
|
||||
The `alfred-sync.sh` script does the following:
|
||||
|
||||
```bash
|
||||
cd /Users/timmy/Sync/AlfredPrefs
|
||||
git add -A
|
||||
git commit -m "sync YYYY-MM-DD HH:MM"
|
||||
git push
|
||||
```
|
||||
|
||||
Customize the path in the script if your repository location differs.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Alfred doesn't show new workflows**
|
||||
- Restart Alfred from the menu bar
|
||||
- Check that the symlink is correctly created
|
||||
|
||||
**Sync fails**
|
||||
- Ensure you have git access to the repository
|
||||
- Check your SSH keys or authentication
|
||||
|
||||
**Changes not appearing**
|
||||
- Run `git pull` to get latest changes
|
||||
- Restart Alfred after pulling
|
||||
Reference in New Issue
Block a user