https://github.com/sotayamashita/dotfiles
dotfiles
https://github.com/sotayamashita/dotfiles
automate bash dotfiles emoji fish fish-shell git macos
Last synced: about 1 month ago
JSON representation
dotfiles
- Host: GitHub
- URL: https://github.com/sotayamashita/dotfiles
- Owner: sotayamashita
- License: mit
- Created: 2015-07-10T02:07:50.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2025-03-13T08:12:12.000Z (about 2 months ago)
- Last Synced: 2025-03-16T14:11:32.159Z (about 2 months ago)
- Topics: automate, bash, dotfiles, emoji, fish, fish-shell, git, macos
- Language: Shell
- Homepage:
- Size: 1.27 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# dotfiles
A streamlined configuration management system for macOS development environments.
## Quick Start
Run this single command to begin the automated setup:
```bash
bash -c "$(curl -fsSL https://raw.githubusercontent.com/sotayamashita/dotfiles/main/bootstrap.sh)"
```
## How It Works
This repository uses a multi-stage setup process to handle SSH dependency constraints on fresh macOS installations:
```mermaid
flowchart TD
Start([Start Execution]) --> CheckState{Check State}
CheckState -->|initial| Stage1[Stage 1: Initial Setup]
CheckState -->|homebrew_installed| Stage2[Stage 2: SSH Configuration]
CheckState -->|ssh_configured| Stage3[Stage 3: Complete Setup]
CheckState -->|completed| AlreadyDone[Setup Already Completed]
CheckState -->|unknown| ResetState[Reset State]
ResetState --> CheckState
Stage1 --> InstallPrereq[Install Prerequisites\nXcode CLT, Homebrew]
InstallPrereq --> SetupCore1[Setup Core Functionality\nSymlinks, Brewfile]
SetupCore1 --> SetupMacOS1[Configure macOS\nDock, System Preferences]
SetupMacOS1 --> SaveState1[Save State: homebrew_installed]
SaveState1 --> Exit1[Temporary Exit\nContinue on Next Run]
Stage2 --> SetupSSH[Configure SSH\n1Password SSH Agent]
SetupSSH --> SaveState2[Save State: ssh_configured]
SaveState2 --> Exit2[Temporary Exit\nContinue on Next Run]
Stage3 --> CloneRepo[Clone Repository\nvia SSH]
CloneRepo --> SetupCore2[Setup Core Functionality\nSymlinks, Brewfile]
SetupCore2 --> RunInstallers[Run Installers\nRust, Volta, uv, etc.]
RunInstallers --> SetupMacOS2[Configure macOS\nDock, System Preferences]
SetupMacOS2 --> CleanupTemp[Clean Up Temporary Files]
CleanupTemp --> SaveState3[Save State: completed]
SaveState3 --> Completed[Setup Complete]
AlreadyDone --> Completed
classDef stage fill:#f9f,stroke:#333,stroke-width:2px;
classDef state fill:#bbf,stroke:#33f,stroke-width:2px;
classDef action fill:#dfd,stroke:#080,stroke-width:1px;
class Stage1,Stage2,Stage3 stage;
class CheckState,SaveState1,SaveState2,SaveState3 state;
class InstallPrereq,SetupCore1,SetupCore2,SetupMacOS1,SetupMacOS2,SetupSSH,CloneRepo,RunInstallers,CleanupTemp action;
```
### Setup Process Stages
1. **Initial Setup**
- Downloads and applies basic configuration
- Installs essential tools (Xcode Command Line Tools, Homebrew)
- No SSH required at this stage
2. **SSH Configuration**
- Sets up 1Password SSH Agent for GitHub authentication
- Prepares secure access for repository cloning
3. **Complete Setup**
- Clones the repository via SSH for proper version control
- Installs all tools and applies full configuration
- Configures macOS preferences
## Manual Setup Alternative
If you prefer more control, you can run the setup process manually:
### Stage 1: Initial Setup (No SSH Required)
```bash
cd
curl -#L https://github.com/sotayamashita/dotfiles/tarball/main | tar -xzv --strip-components 1 --exclude={README.md}
~/scripts/modules/core/symlinks.sh
~/scripts/modules/core/brew.sh
rm -rf ~/scripts
```
This will:
- Download the repository as a tarball to your home directory
- Install essential tools
- Apply basic configuration
- Clean up temporary files
### Stage 2: Complete Setup (SSH Required)
After completing the initial setup:
1. **Configure 1Password SSH Agent**:
- Install 1Password from Homebrew
- Enable SSH Agent in 1Password:
1. `open -a "1Password"`
2. Press ⌘ + , to open Preferences
3. Navigate to Developer > Use the SSH Agent and enable it
[Learn more about 1Password SSH Agent](https://developer.1password.com/docs/ssh/agent/)
2. **Clone repository to permanent location**:
```bash
git clone [email protected]:sotayamashita/dotfiles.git ~/Projects/dotfiles
cd ~/Projects/dotfiles
```
3. **Run setup scripts**:
```bash
./scripts/modules/core/symlinks.sh
./scripts/modules/core/brew.sh
./scripts/modules/macos/preferences.sh
```
[Learn more about signing Git commits with SSH](https://developer.1password.com/docs/ssh/git-commit-signing/)
## Repository Structure
```
dotfiles/
├── .config/ # Configuration files
├── installers/ # Individual tool installers
├── bootstrap.sh # Automated setup script
└── scripts/ # Setup scripts
├── lib/ # Common library functions
│ ├── utils.sh # Utility functions
│ └── state.sh # State management
├── modules/ # Modular scripts by functionality
│ ├── core/ # Core functionality
│ │ ├── symlinks.sh # Symlink creation
│ │ └── brew.sh # Homebrew package management
│ └── macos/ # macOS specific settings
│ ├── dock.sh # Dock configuration
│ └── preferences.sh # System preferences
└── installers/ # External tool installers
```
## Platform Support
This dotfiles repository is optimized for:
- **macOS**: Full support with macOS-specific configurations
The bootstrap process automatically applies the appropriate configurations for your system.