88         88
                                                   88         ""    ,d
                                                   88               88
8b,dPPYba,   ,adPPYYba,  8b,dPPYba,    ,adPPYba,   88   ,d8   88  MM88MMM
88P'   `"8a  ""     `Y8  88P'   `"8a  a8"     "8a  88 ,a8"    88    88
88       88  ,adPPPPP88  88       88  8b       d8  8888[      88    88
88       88  88,    ,88  88       88  "8a,   ,a8"  88`"Yba,   88    88,
88       88  `"8bbdP"Y8  88       88   `"YbbdP"'   88   `Y8a  88    "Y888

• ⚡ A lightweight, fast, and efficient cross-platform development setup for Linux (x86/arm), OSX
• ✨ No sudo required - Everything installs to $HOME/.pixi, completely user-local
• 🪄 Pixi as a shell tool manager - Keep your tools up-to-date by declarative management
• 🦀 dotter as a simple dotfile manager that links / unlinks dotfiles in nanokit
• 🐚 zsh 🎩 sheldon 🚀 starship - Modern shell experience with plugin management

Install pixi following the official installation guide:

curl -fsSL https://pixi.sh/install.sh | sh

If your system doesn't have curl, you can use wget:

wget -qO- https://pixi.sh/install.sh | sh

Install GitHub CLI (recommended) or git:

pixi global install gh
# or
pixi global install git

Using 🔀 git:

git clone https://github.com/denkiwakame/nanokit.git
cd nanokit

Using gh (recommended - includes SSH key setup):

gh auth login

# Where do you use GitHub? → GitHub.com
# What is your preferred protocol? → SSH
# Generate a new SSH key? → Yes
# How would you like to authenticate? → Login with a web browser

gh repo clone denkiwakame/nanokit
cd nanokit

Using 🔀 git:

git clone https://github.com/denkiwakame/nanokit.git
cd nanokit

./nanokit install

That's all you need to get started!

pixi global install dotter-rs

dotter -d       # dry run: confirm what happens

dotter deploy

pixi global sync

zsh

tmux

dotter undeploy -d
dotter undeploy
touch ~/.pixi/manifests/pixi-global.toml
pixi global sync

For local terminals, installing fonts is recommended. Fonts will be installed to $HOME/.local/fonts.

See Starship Presets for more customization options.

The following tools are available through pixi-global.toml:

	Tool	Description	Exposed Command	GitHub
🔀	git	Version control system	git, git-cvsserver, git-receive-pack, git-shell, git-upload-archive, git-upload-pack, gitk, scalar	git/git
	gh	GitHub CLI	gh	cli/cli
🔀	git-lfs	Version control system	git-lfs	git/git
🔀	tig	TUI client for Git	tig	jonas/tig
🐚	zsh	Z shell	zsh, zsh-5.9	zsh-users/zsh
🎩	sheldon	Fast and configurable shell plugin manager	sheldon	rossmacarthur/sheldon
🚀	starship	Minimal, beautifl prompt for any shell	starship	starship/starship
🦀	dotter-rs	Dotfile manager	dotter	SuperCuber/dotter
🔐	sshs	TUI client for ssh	sshs	quantumsheep/sshs
📊	htop	Interactive process viewer	htop	htop-dev/htop
📊	bottom	System monitor	btm	ClementTsang/bottom
🔎	fzf	Fuzzy finder	fzf	junegunn/fzf
📁	tree	Directory tree display	tree	Old-Man-Programmer/tree
📁	go-ghq	Git repository manager	ghq	x-motemen/ghq
🌲	gwq	Git worktree manager	gwq	d-kuro/gwq
🌀	zoxide	Smart directory jumper	zoxide	ajeetdsouza/zoxide
🛠️	make	Build automation tool	make	mirror/make
📋	xsel	X11 clipboard manipulation	xsel	kfish/xsel
🗄️	pueue	Local job queue manager	pueue, pueued	Nukesor/pueue
🪟	tmux	Terminal multiplexer	tmux	tmux/tmux
💽	dua-cli	Disk usage analyzer	dua	Byron/dua-cli
💽	diskonaut	Disk space navigator	diskonaut	imsnif/diskonaut
🦇	bat	Better cat with syntax highlighting	bat	sharkdp/bat
📂	lsdeluxe	Modern ls replacement	lsd	lsd-rs/lsd
⚙️	nodejs	Node.js runtime	node, npm, npx	nodejs/node
⚙️	jq	Command-line JSON processor	jq	jqlang/jq
🌍	xh	Friendly and fast tool for sending HTTP requests	xh	ducaale/xh
☁️	rclone	rsync for cloud storage	rclone	rclone/rclone
☁️	aws	CLI for AWS	aws aws_completer	aws/aws-cli
📝	neovim	Neovim with Node.js, Lua, Python support	nvim	neovim/neovim
📝	helix	A post-modern modal text editor	hx	helix-editor/helix

Add your favorite tools with:

pixi search <package-name>
pixi global install <package-name>  # e.g. pixi global install python=3.13

This will automatically update the pixi-global.toml configuration.

pixi global update

automatically upgrade all tools except for version-pinned packages.

see Pixi Global: Declarative Tool Installation for details.

Customize your prompt by editing starship.toml. See Starship Themes.

For detailed configuration options, see the Starship documentation.

Manage plugins by editing zshrc and sheldon.toml.

For more plugin management options, see the Sheldon documentation.

Manage symlinks for dotfiles by editing .dotter/global.toml.

For detailed configuration options, see the dotter documentation.

The combination of ghq and zoxide creates a magical workflow for repository management:

ghq provides a clean way to organize remote repository clones. When you run:

ghq get {repo-url}

It automatically clones the repository to a well-structured directory hierarchy under ~/ghq, regardless of your current location. For example:

ghq get https://github.com/user/project
# Creates: ~/ghq/github.com/user/project

Once you cd into any directory, zoxide remembers that location. You can then use:

zi  # Interactive fuzzy finder for visited directories
z <partial-name>  # Jump to directory matching the pattern

No more cd ../../../project - just zi and you're there! 🎯

gwq is to branches what ghq is to repositories — a structured, ghq-style manager for git worktree. Instead of juggling git worktree add ../some-path by hand, gwq lays worktrees out under $GHQ_ROOT using the naming template configured in gwq.toml:

$GHQ_ROOT/github.com/{owner}/{repo}.{branch}

Common commands:

gwq add <branch>     # create a worktree for <branch> (auto-cd into it)
gwq list             # list avaialable worktrees
gwq remove           # prune a worktree

With auto_cd_on_add = true (already set in gwq.toml) and the shell integration sourced in zshrc (source <(gwq completion zsh)), gwq add drops you straight inside the new worktree, 🌀 zoxide quietly memorizes the path along the way. So next time, just zi and you're back in the worktree you wanted. 🎯

The tmux configuration uses Ctrl+a as the prefix key (instead of the default Ctrl+b). Here are the essential key bindings:

💡 Tip: All panes and windows are created in the current working directory for better workflow.

Basic commands to get started:

• vi - Launch Neovim
• :q - Quit Neovim
• :checkhealth - Check Neovim configuration
• :Lazy - Plugin manager interface
• Ctrl+P - Fuzzy file finder

To reduce the risk of installing recently-published (and potentially compromised) packages, nanokit ships release-age cooldown configs for npm and uv, managed by dotter.

A 7-day cooldown blocks the majority of real-world supply chain incidents, since compromised packages are typically caught and pulled within hours or days. See Package Managers Need to Cool Down and Dependency Cooldowns.

Pixi's exclude-newer is currently workspace-only — it is not available in user-level ~/.pixi/config.toml (config reference). Add it manually to each project's pixi.toml | pyproject.toml:

[workspace]
exclude-newer = "7d"  # requires pixi v0.67.0+

This applies to both conda and PyPI packages within that workspace. For pixi global (i.e. pixi-global.toml), cooldown is not yet supported upstream.

Want to test nanokit without affecting your current setup? Create a temporary user:

sudo adduser nanokit
su - nanokit
# Try nanokit setup here

Cleanup test user:

sudo userdel -r nanokit    # Remove user and home directory