skillmirror
Getting started

بِسْمِ ٱللَّهِ ٱلرَّحْمَـٰنِ ٱلرَّحِيمِ

Install

Build skillmirror from source, check the machine with doctor, and switch on tab completion.

skillmirror is built from source with Rust. The install should inshallah work on your machine: it needs Linux, git and Rust 1.89 or newer. just is optional.

The build takes about a minute and a quarter and peaks near 0.9 GB of memory with all cores busy. On a small machine, CARGO_BUILD_JOBS=1 brings the peak to about 0.5 GB and the build to about four minutes.

Get the source

git clone https://github.com/jav-ed/skill_Manag.git
cd skill_Manag

Build and install

just install

Without just, this line does the same:

cargo install --path Crates/Cli --locked

The binary lands in ~/.cargo/bin/skillmirror. Make sure that folder is on your PATH. The build folder is removed afterwards.

Check it

skillmirror --version
skillmirror doctor
skillmirror 0.1.0

Before the first run there is no vault yet, so doctor says exactly that and exits with 3. This is the expected state, and the next page makes the vault.

✓ git
✓ pointer
✓ legacy
✓ backups
✓ config
✗ vault: no vault configured
    hint: pass --vault, set SKILLMIRROR_VAULT, or run the setup wizard
! scan: no scan root configured
    hint: pass --root, set SKILLMIRROR_ROOT, or add `root:` to <vault>/config.yaml

1 error, 1 warning

Turn on tab completion

The install does not switch completion on. Your shell has to be told once, with one line in its startup file. Until then skillmirror sy plus Tab does nothing.

# in ~/.zshrc, after the line that starts oh-my-zsh or runs compinit
source <(skillmirror completions zsh)

Open a new terminal and try skillmirror sy plus Tab. The line runs the installed binary each time a shell starts (a few milliseconds), so the completion always matches your version and there is no file to refresh after an upgrade. elvish and powershell are supported too. Commands, options and options with a fixed set of values are completed. Skill names, groups and projects are not.

The web view is a separate build

A plain install leaves out the web view and its server. just install-web builds it in, and a second switch in the vault configuration keeps it off until you turn it on. Look before you sync has the details.

Upgrade

Pull the source and run the install again. It replaces the binary in ~/.cargo/bin.

Coming from skill_Manag

skillmirror is the Rust successor of the Go tool skill_Manag.

skillmirror migrate

migrate copies the vault pointer of the old tool (~/.config/skill_Manag/vault) to ~/.config/skillmirror/vault. Add --retire to remove the old pointer file afterwards, so the old tool stops finding the vault. The old variables SKILL_MANAG_VAULT and SKILL_MANAG_ROOT are refused with a message that names the new variable, see Troubleshooting.

Next: First run.

On this page