dots

command module
v0.0.0-...-de90c35 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2024 License: MIT Imports: 1 Imported by: 0

README

Dots

Obsessively curated dotfiles.

Managed by a robust, extensible Go CLI.


Github Go Report Card Maintainability

Notice

Warning: This install script destructively installs configuration and various tools onto your system. It does not backup existing configuration. Run at your own risk.

Install

git clone https://github.com ~/.dots
cd ~/dots
go install ./...
dots install all

Dependencies

  • Homebrew
  • Go
    • Installed via homebrew (brew install go)
    • export GOPATH=$HOME/go
    • export PATH=$GOPATH/bin:$PATH

Commands

Top-level commands:

❯ dots

The dots CLI manages your development environment dependencies

Usage:
  dots [flags]
  dots [command]

Available Commands:
  clean       Cleans legacy configuration
  docker      Docker command aliases
  doctor      Runs system diagnostics
  help        Help about any command
  install     Installs configuration
  spinner     Runs simple CLI spinners
  update      Updates configuration

Flags:
  -h, --help   help for dots

Use "dots [command] --help" for more information about a command.

Install commands:

❯ dots install --help

Installs configuration

Usage:
  dots install [flags]
  dots install [command]

Available Commands:
  all         Runs all install scripts
  bin         Installs ~/bin/* commands
  fonts       Installs fonts
  git         Installs git extensions
  hammerspoon Installs hammerspoon configuration
  home        Installs ~/.* config files
  homebrew    Installs Homebrew dependencies
  languages   Installs asdf & languages
  npm         Installs npm packages
  osx         Installs OSX configuration
  vim         Installs vim config
  zsh         Installs zsh config files

Flags:
  -h, --help   help for install

Use "dots install [command] --help" for more information about a command.

License

This project is licensed under the MIT License

Documentation

Overview

Dots CLI

Directories

Path Synopsis
cli
commands
Package commands manages all top-level CLI commands
Package commands manages all top-level CLI commands
commands/clean
Package clean cleans up homebrew and vim plugin artifacts
Package clean cleans up homebrew and vim plugin artifacts
commands/doctor
Package doctor runs system diagnostic commands
Package doctor runs system diagnostic commands
commands/install
Package install contains all environment bootstrapping logic
Package install contains all environment bootstrapping logic
commands/spinner
Package spinner provides CLI spinner functions
Package spinner provides CLI spinner functions
commands/update
Package update manages system update logic
Package update manages system update logic
config
Package config provides functionality to interact with and modify dots configuration stored as an INI file located at ~/.dots/sys/config
Package config provides functionality to interact with and modify dots configuration stored as an INI file located at ~/.dots/sys/config
git
Package git provides git-releated helper functions
Package git provides git-releated helper functions
is
Package is manages helper functions that return booleans
Package is manages helper functions that return booleans
link
Package link provides functions to create soft and hard links
Package link provides functions to create soft and hard links
tmux
Package tmux contains integration with tmux CLI
Package tmux contains integration with tmux CLI
cmd
battery-percent
Prints the current battery remaining percentage
Prints the current battery remaining percentage
battery-state
Prints the current battery remaining percentage
Prints the current battery remaining percentage
cpu
Outputs the current laptop battery %
Outputs the current laptop battery %
git-ancestor
Determines the most recent ancestor branch and remote of current git `HEAD`
Determines the most recent ancestor branch and remote of current git `HEAD`
git-canonical-branch
Writes the canonical branch to STDOUT
Writes the canonical branch to STDOUT
git-canonical-path
Writes the canonical path to STDOUT
Writes the canonical path to STDOUT
git-canonical-remote
Writes the canonical remote to STDOUT
Writes the canonical remote to STDOUT
git-killme
`git killme`.
`git killme`.
git-masterme
Pushes the current branch to the canonical remote's canonical branch
Pushes the current branch to the canonical remote's canonical branch
git-rebase-master
Rebase on top of the canonical path
Rebase on top of the canonical path
git-reset-hard-master
Resets hard to canonical remote & branch
Resets hard to canonical remote & branch
gps
Outputs the lat,lng of the current external IP
Outputs the lat,lng of the current external IP
home-scp
home-scp sends the specified file home via scp
home-scp sends the specified file home via scp
ip
Outputs the machine's LAN IP, the router's IP, or the network's WAN IP
Outputs the machine's LAN IP, the router's IP, or the network's WAN IP
router
Opens browser to the router's IP if available
Opens browser to the router's IP if available
search-github
Usage: search-github [github-org] [search-term] Opens browser to code search view for the input github org and search term.
Usage: search-github [github-org] [search-term] Opens browser to code search view for the input github org and search term.
spotify
This package provides a Spotify CLI to toggle, save, and remove the current song
This package provides a Spotify CLI to toggle, save, and remove the current song
spotify/auth
Package auth manages Spotify API auth
Package auth manages Spotify API auth
ssid
If available, prints out WiFi SSID currently connected to.
If available, prints out WiFi SSID currently connected to.
tmux-status
Outputs tmux statusline configurations for the given input position & screen width
Outputs tmux statusline configurations for the given input position & screen width
tmux-status/center
Package center outputs configuration for the tmux-status center section
Package center outputs configuration for the tmux-status center section
tmux-status/color
Package color contains tmux-status color constants
Package color contains tmux-status color constants
tmux-status/left
Package left outputs configuration for the tmux-status left section
Package left outputs configuration for the tmux-status left section
tmux-status/right
Package right outputs configuration for the tmux-status right section
Package right outputs configuration for the tmux-status right section
tmux-status/separator
Package separator provides tmux-status separator constants
Package separator provides tmux-status separator constants
weather
Outputs the current weather and temperature for use with status lines.
Outputs the current weather and temperature for use with status lines.
weather/openweather
Package openweather - https://openweathermap.org/
Package openweather - https://openweathermap.org/
weather/wttr
Package wttr - https://github.com/chubin/wttr.in
Package wttr - https://github.com/chubin/wttr.in
pkg
cache
Package cache provides functionality to manage basic file-based caching located at ~/.dots/sys/cache
Package cache provides functionality to manage basic file-based caching located at ~/.dots/sys/cache
log
Package log provides various colorized logging functions
Package log provides various colorized logging functions
path
Package path returns path-related helper functions
Package path returns path-related helper functions
run
Package run triggers system commands
Package run triggers system commands

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL