dotfiles  by nicknisi

Dotfiles management and shell customization

Created 13 years ago
2,855 stars

Top 16.7% on SourcePulse

GitHubView on GitHub
Project Summary

This repository contains a curated set of dotfiles for developers, primarily targeting macOS users, to streamline their workflow and enhance productivity through customized configurations for Vim/Neovim, Zsh, Git, and Homebrew. It offers a robust dot command-line tool for managing these configurations, including backup, linking, and package management.

How It Works

The core of this setup is a custom dot command, written in Go, which acts as a central manager for all configurations. It uses symlinks to manage dotfiles, allowing them to reside anywhere on the filesystem. The Zsh configuration is heavily customized with plugins managed by zfetch and features a minimal, informative prompt that displays Node.js versions and suspended job indicators. Neovim is configured with Lua and lazy.nvim for plugin management, while tmux offers a dynamic status bar with Git status and music integration, adapting to macOS dark/light modes.

Quick Start & Requirements

  • Install: Clone the repository and run bin/dot link from the root.
  • Prerequisites: macOS, Xcode CLI tools. Homebrew is managed by the dot homebrew command.
  • Setup Time: Estimated to be under 15 minutes for basic setup.
  • Links: YouTube talk (note: configuration has changed since video).

Highlighted Details

  • Custom dot command for unified dotfiles management.
  • Neovim configuration primarily in Lua with lazy.nvim.
  • Tmux with dynamic status bar, Git integration, and music display.
  • Zsh prompt with Node.js version and job indicators.
  • macOS system defaults configuration.

Maintenance & Community

The repository is maintained by nicknisi. For questions or issues, users are encouraged to open a new discussion on GitHub.

Licensing & Compatibility

The repository's license is not explicitly stated in the README. However, the permissive nature of the content suggests it is intended for personal use and modification, with no explicit restrictions mentioned for commercial use or closed-source linking.

Limitations & Caveats

The configuration is heavily optimized for macOS and may require significant adaptation for other operating systems. The Neovim setup may initially show errors due to plugin installation on the first run. Git status indicators in tmux require a Nerd Font for proper display.

Health Check
Last Commit

4 days ago

Responsiveness

Inactive

Pull Requests (30d)
1
Issues (30d)
1
Star History
14 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.