Skip to content

README.md

Latest commit

 

History

History
195 lines (140 loc) · 2.88 KB

README.md

File metadata and controls

195 lines (140 loc) · 2.88 KB
Raw

dotfiles-check

A tiny terminal environment checker for shells, CLI tools, developer tools, and common dotfiles variables.

No installation.

No dependencies beyond a POSIX-ish shell and standard system utilities.

Quick Test

Run directly:

curl -fsSL https://raw.githubusercontent.com/nihitdev/dotfiles-check/main/dotcheck.sh | bash

Or inspect the script first:

curl -fsSL https://raw.githubusercontent.com/nihitdev/dotfiles-check/main/dotcheck.sh

What Does "Current Shell" Mean?

dotfiles-check distinguishes between your configured login shell and the shell actually running the checker.

For example:

Login shell: /usr/bin/fish
Running:     fish

If you run the zero-install command:

curl -fsSL https://raw.githubusercontent.com/nihitdev/dotfiles-check/main/dotcheck.sh | bash

the script is executed by Bash, so you may see:

Login shell: /usr/bin/fish
Running:     bash

That is expected.

Clone

git clone https://github.com/nihitdev/dotfiles-check.git
cd dotfiles-check

Then:

./dotcheck.sh

What It Checks

Shell

Checks for common shells and shell tools:

fish
zsh
bash
starship
zoxide

CLI

Checks for modern terminal tools:

bat
eza
ripgrep
fd
fzf
jq
fastfetch

Development

Checks for common development tools:

git
gh
cargo
rustc
go
node
npm
deno
python
docker

Environment

Checks useful environment variables such as:

SHELL
EDITOR
VISUAL
TERM
COLORTERM

Example

dotfiles-check
────────────────────────────────────────

Shell
  ✓ Fish
  ✓ Zsh
  ✓ Bash
  ✓ Starship
  ✓ zoxide

CLI
  ✓ bat
  ✓ eza
  ✓ ripgrep
  ✓ fd
  ✓ fzf

Development
  ✓ Git
  ✓ GitHub CLI
  ✓ Rust
  ✓ Cargo
  ✓ Go
  ✓ Node.js
  ✗ Docker

────────────────────────────────────────
Result: 16/17 checks passed

A missing tool does not mean your setup is broken.

The goal is to show what is available, not tell you what you must install.

Structure

dotfiles-check/
├── README.md
├── LICENSE
├── dotcheck.sh
└── checks/
    ├── commands.sh
    ├── environment.sh
    └── shell.sh

Philosophy

Your dotfiles should be understandable.

This project intentionally avoids:

  • automatic package installation
  • modifying shell configuration
  • changing system settings
  • requiring root
  • Giant setup frameworks

It checks.

You decide.

Related

License

MIT