InstantCLI

DOCS LIVE AT instantos.io/docs/ins

A powerful, Rust-based command-line tool for managing dotfiles, system diagnostics, WM keychords, game saves and much more.

Features

• dotfile management
• system diagnostics
• WM keychord management
• game save management
• video editing (yes, I know it's random)

Removed dotfiles

ins dot apply and ins dot update reconcile files that were previously applied from a dotfile repository:

• If a source deletion is committed to the repository and no other active source provides the target, an unchanged target is removed.
• A locally modified target is preserved and becomes unmanaged.
• Staged or unstaged source deletions do not remove targets.
• Disabled, removed, unreadable, or failed-to-update repositories do not trigger target deletion.
• Normal ins dot update --include-root and ins dot apply --include-root delegate root reconciliation while root sources still exist. If every root source has already been removed, no sudo child is spawned solely for stale tracking records; run ins dot apply --root-only explicitly to reconcile those final root targets.

Tracking starts when a source and target are first confirmed identical after upgrading. Sources that were already deleted before this tracking state was recorded cannot be reconciled safely.

Dotfile status is content-based: a target containing a known previous source version is reported as outdated whenever it differs from the effective source, regardless of file modification times.

Installation

Quick install

curl -fsSL https://raw.githubusercontent.com/instantOS/instantCLI/main/scripts/install.sh | sh

Set INSTALL_DIR to override the destination directory (defaults to a writable user bin in your PATH, otherwise /usr/local/bin).

Check before you pipe :)

Cargo

cargo install ins

AUR

yay -S ins

From Source

# Clone the repository
git clone https://github.com/your-username/instantCLI.git
cd instantCLI

# Build and install locally
just install

# Or install system-wide (requires sudo)
just rootinstall

Dependencies

• Rust
• Git
• FZF
• Restic
• SQLite3

Arch

sudo pacman -Sy git fzf restic sqlite --needed

Ubuntu

sudo apt update; sudo apt install -y git fzf restic sqlite3 pkg-config libssl-dev libgit2-dev libsqlite3-dev

Development

Building

# Debug build
cargo build

# Release build
cargo build --release

# Run with debug logging
cargo run -- --debug <command>

Testing

# Run all tests
cargo test

# Run integration tests
just test