pt/setup_env
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document .bashrc_paths pattern and machine-specific config workflow

Browse Source
This commit is contained in:
Paul Trowbridge 2026-05-10 02:12:36 -04:00
parent 9da62c0908
commit a2ffa6afb5
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CLAUDE.md
View File

@ -52,8 +52,10 @@ All dotfiles are symlinked, not copied. Editing `~/.<file>` directly modifies fi
**Critical Files:** **Critical Files:**
- `dotfiles/.bashrc` - Main bash configuration with extensive aliases and functions - `dotfiles/.bashrc` - Main bash configuration with extensive aliases and functions
- `dotfiles/.bashrc_local` - Machine-specific environment variables (PG, MS connection strings) - `dotfiles/.bashrc_local` - Machine-specific secrets and credentials (PG, MS connection strings)
- `dotfiles/.bashrc_local_example` - Template for setting up machine-specific configs - `dotfiles/.bashrc_local_example` - Template for `.bashrc_local`
- `dotfiles/.bashrc_paths` - Machine-specific PATH additions and tool inits
- `dotfiles/.bashrc_paths_example` - Template for `.bashrc_paths`
- `dotfiles/.vimrc` - Vim configuration using Vundle plugin manager - `dotfiles/.vimrc` - Vim configuration using Vundle plugin manager
- `dotfiles/.tmux.conf` - Tmux configuration with vim-style pane navigation - `dotfiles/.tmux.conf` - Tmux configuration with vim-style pane navigation
- `dotfiles/.gitconfig` - Git configuration with custom log format and vimdiff - `dotfiles/.gitconfig` - Git configuration with custom log format and vimdiff
@ -126,10 +128,20 @@ Base packages installed by `setup_env.sh`:
## Important Conventions ## Important Conventions
### Environment Variables ### Machine-specific configuration
Machine-specific environment variables (database connections, tokens, passwords) belong in `dotfiles/.bashrc_local`, not `.bashrc`. This file is sourced by `.bashrc` and should contain sensitive or machine-specific configuration.
The `.bashrc_local` file is gitignored for security. Use `dotfiles/.bashrc_local_example` as a template when setting up a new machine. Copy it to `.bashrc_local` and fill in your actual credentials. There are two gitignored files for machine-specific configuration, both sourced by `.bashrc`:
- **`.bashrc_local`** — secrets and credentials: database connection strings, passwords, tokens. Use `dotfiles/.bashrc_local_example` as a template.
- **`.bashrc_paths`** — PATH additions and tool initializations: neovim, cargo, nvm, java, etc. Use `dotfiles/.bashrc_paths_example` as a template.
On a new machine, copy both examples and fill them in:
```bash
cp dotfiles/.bashrc_local_example dotfiles/.bashrc_local
cp dotfiles/.bashrc_paths_example dotfiles/.bashrc_paths
```
When a tool (cargo, nvm, conda, etc.) auto-appends lines to `.bashrc`, `git status` will show the modification — that's your signal to move those lines to `.bashrc_paths` instead.
### Symlink Pattern ### Symlink Pattern
When modifying dotfiles, remember they are symlinked. Changes are automatically tracked by git since the actual files are in the repository's `dotfiles/` directory. When modifying dotfiles, remember they are symlinked. Changes are automatically tracked by git since the actual files are in the repository's `dotfiles/` directory.