Skip to content

CLI for color-coding project windows, enhancing workspace organization

License

Notifications You must be signed in to change notification settings

joelzanden/mine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mine

mine is a nifty CLI app that adds a splash of color to your workspace. By choosing a hue from the vast array of CSS named colors, mine allows you to tell your projects apart with just a glance.

Why?

Juggling multiple repositories locally was challenging until this tip from Wes Bos of the Syntax podcast came to the rescue. Now, mine handles the once-tedious task of creating VS Code settings for each cloned repo. Thank you!

Features

  • Locates project root and updates settings automatically
  • Selects random hues from CSS named colors
  • Enhances visual project distinction
  • Supports Visual Studio Code, with more editors soon

Screenshots

Indian Red with Cobalt2 theme

Screenshot of a VS Code project window with a indian red colored title bar

Gold with Solarized Light theme

Screenshot of a VS Code project window with a gold colored title bar

Deep Pink with Material Theme Darker theme

Screenshot of a VS Code project window with a eep pink colored title bar

Installation

Homebrew

Preferred installation for MacOS and Linux via Homebrew:

brew install joelzanden/tap/mine

Precompiled binaries

You can download precompiled binaries for Windows, Linux and MacOS from the releases page.

Build from Source

With Rust and Cargo installed, build mine from source:

cargo build --release

Usage

Install mine, add to your system's PATH, then run in your project directory:

mine

This command finds the project root, updates the settings file with a random CSS named color, and applies it to the editor's title bar.

Supported Project Files and Folders

mine detects and locates project hierarchy roots by searching for specific project files and folders.

Expand to see a list of the currently supported files and folders
Language / Framework File(s)
General .dockerignore, .editorconfig, .git, .github, .gitignore, .gitlab-ci.yml, .travis.yml, Dockerfile, Jenkinsfile, LICENSE, README.md, Vagrantfile, .vscode
Angular angular.json
ASP.NET project.json
C# .csproj, .fsproj, .sln, project.json
C++ CMakeLists.txt, Makefile
Clojure project.clj
Crystal shard.yml
Dart pubspec.yaml
Elixir mix.exs
Elm elm.json
Ember ember-cli-build.js
Erlang rebar.config
F# paket.dependencies
Go go.mod
Groovy build.gradle
Haskell stack.yaml
Java build.gradle, pom.xml
Julia Project.toml
Lua lua
Meteor meteor
Nim nim.cfg
Node lerna.json, package.json, yarn.lock
OCaml dune
Perl cpanfile
PHP composer.json
PowerShell psakefile.ps1
Python Pipfile, pyproject.toml, requirements.txt, setup.py
R DESCRIPTION
Ruby .gemspec, Gemfile, Rakefile
Rust Cargo.toml
Scala build.sbt
Svelte svelte.config.js
Swift Package.swift
TypeScript tsconfig.json
Vue vue.config.js

Contributing

If you're interested in contributing, please feel free to open an issue or submit a pull request.

About

CLI for color-coding project windows, enhancing workspace organization

Resources

License

Stars

Watchers

Forks

Languages