Skip to content

Update README.md with dotfiles example #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rgraff wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md with dotfiles example #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,23 @@ To uninstall: `uv tool uninstall jeff`
uv sync
```

### Dotfiles / scripted install

If you manage your environment with a dotfiles repo, you can automate the install with a script like `.dotfiles/jeff/install.sh`:

```bash
#!/usr/bin/env bash
set -e
tmpdir=$(mktemp -d)
trap 'rm -rf "$tmpdir"' EXIT

cd "$tmpdir"
git clone https://github.com/BJClark/jeff.git
cd jeff
uv tool install .
uv sync
```

## AI Assistant Setup

Jeff is designed to work with AI coding assistants. Each tool has its own configuration format for project context.
Expand Down