@visulima/vis
v6.4.2
Published
A monorepo dev toolkit — task runner, remote caching, security scanning, git hooks, and AI agent integrations — powered by @visulima/task-runner
Maintainers
Readme
Features
Built for AI agents
- MCP server —
@visulima/vis-mcpexposes 8 read-only introspection tools to Claude / Cursor / Copilot (project graph, target list, run logs, cache-why, template schema), plus a paired Claude Skill that documents optimal usage vis ai heal— reads failing tasks, asks the configured AI provider for a structured patch, validates by re-running, posts a markdown comment to the PR/MR./vis heal acceptfrom an allow-listed maintainer lands the fix as a signed commit (GitHub Actions, GitLab CI, Buildkite)- Worktree-aware shared cache — N parallel agents in N sibling git worktrees automatically share one cache instead of rebuilding the same hash N times
Production-grade caching
- REAPI gRPC + HTTP backends — drop-in support for bazel-remote, BuildBuddy, BuildBarn, EngFlow alongside Turbo-compatible HTTP.
vis cache doctorprobes reachability, capabilities, and latency for CI gating vis cache why <task>— diff hash buckets (command,nodes,runtime,implicitDeps) against the previous run to pinpoint exactly what rotated the hash- HMAC-SHA256 signed artifacts —
verifyOnDownloadlocks production caches against tampering with constant-time comparison - Cache restoration fidelity — preserves mtime + permission bits + colorized output;
vis cache verify <task>flags drift between cached archive and live workspace - Retention controls —
vis cache prune --keep-last/--max-age-days/--max-size
Cross-invocation devloop
vis service start|stop|list— long-lived DB / mock / devserver lifecycle that survives acrossvis runcalls within a shell session; auto-attached when targets declareservice:in their config (no more "I keep restarting Postgres between every test run")vis run --watch— Vitest-style keybinds (r/Enter/a/p/q/Ctrl+C/h/?), Windows-clean SIGINTvis run --output-style=quiet— swallow stdout from successful and cached tasks, keep failures fully visible
Workspace orchestration
- Workspace-aware — discovers projects from
pnpm-workspace.yaml,package.jsonworkspaces, and bun - Topological scheduling with configurable parallelism and runner-tag filtering
- Affected detection —
vis affected <target>, plus${affected.files}/$AFFECTED_FILEStoken forwarding to the underlying script - Conditional + finally tasks —
when:(os/env/branch/ci) and top-levelalways: true - Per-package overlay + extends chain — root
vis-config.ts+ per-projectvis.task.ts, with bare-specifier preset resolution - Inferred targets (Project Crystal-style) — optional synthesis of
build/test/dev/lint/formatfrom 36 tools (Vite, Vitest, Next, Nuxt, packem, ESLint, Biome, Prisma, …). Opt in withinferTargets: true; explicit scripts andproject.json/vis.task.tsoverrides always win - URI-based input format —
inputsacceptsfile://,glob://,env://,func://,dep://strings as forward-compat sugar - Plugin / fingerprint hooks — 14 typed hooks via
definePlugin(lifecycle, streaming, retry, fingerprint, services), built onhookable - Strict env mode —
--strict-envextracts${VAR}references from each command and fails the task if any are unset - Lockfile preflight — warns in TTY, hard-fails in CI when the lockfile is newer than the install marker
- Project graph — view dependencies in ASCII, DOT, JSON, or HTML
Adjacent tooling that ships in-box
vis catalog check / update— pnpm + bun workspace catalog managementvis secrets— Rust-native secret scanning (gitleaks detection engine)vis audit— OSV.dev vulnerability scanning with pluggable supply-chain providers (Socket.dev and Google deps.dev, merged when both are enabled).--explainadds a plain-English AI explanation per finding (auto-detects an installed AI CLI, cached, no API key) in the terminal, JSON, and HTML reportvis docker scaffold— lockfile pruning for pnpm / npm / yarn classic + berry / bun, matching turbo's killer Docker-cache featurevis hook install / migrate— git hooks (husky migration supported)vis staged— built-inlint-stagedreplacement, no peer dependencyvis migrate gitleaks|secretlint— incremental migration pathsvis replay <runId>— re-render any past run summary without re-execution
Toolchain & runtime
- Pluggable installer — defaults to the lockfile-detected PM (pnpm/npm/yarn/bun); auto-uses aube when on
PATH, with a single switch (install.backend/--installer/--no-aube) to pin or bypass it - Cold-start one-liner —
curl -fsSL https://visulima.com/install.sh | bash(Linux/macOS/WSL) or PowerShell equivalent installs the latest Node LTS (or a version manager on request) andvis vis toolchain— delegates to proto / mise / fnm / volta- Built on Cerebro — robust CLI with built-in help, version, and shell completion
New to vis? See Why vis vs. Vite Task / Turbo / Nx / moon for the side-by-side capability matrix.
Install
npm install @visulima/visyarn add @visulima/vispnpm add @visulima/visBinaries
@visulima/vis installs four executables:
vis— the full CLI (recommended; use this in scripts and CI). Note that macOS and the BSDs ship an unrelated/usr/bin/vis(a text-encoding utility). That one only wins if the localnode_modules/.bin/visis missing — most often momentarily, mid-install — and the giveaway is output likevis: run: No such file or directory, one line per argument. If you see that, finish the install (or re-run viapnpm exec vis) rather than debugging the command you typed.v— a short alias forvis. Note thatvcollides with the V language compiler and is a common personal shell alias, so it may be shadowed. Prefervisfor anything you commit; seedocs/guides/shell-alias.mdxif you want your own short alias.vx/visx— the leandlx-only entry point for one-off package execution.
Cold start (no Node? no manager?)
One-liner bootstrap that installs Node and vis in one go. When no Node is found it installs the latest Node LTS directly by default (OS package manager, falling back to the official nodejs.org build); a version manager (proto / fnm / mise / volta) is offered as an opt-in alternative. Pin a specific major with VIS_NODE_MAJOR.
Linux / macOS / WSL (bash):
curl -fsSL https://visulima.com/install.sh | bashWindows (PowerShell 5.1+):
irm https://visulima.com/install.ps1 | iexPass --yes --manager=proto (POSIX) or -Yes -Manager proto (PowerShell) for non-interactive / CI usage. See vis toolchain docs for details.
Quick Start
# Run a target across all workspace projects
vis run build
# Run tests only on affected projects
vis affected test --base=main
# Visualize the project dependency graph
vis graph
# Check for outdated catalog dependencies
vis check
# Check with security vulnerability scanning
vis check --security
# Update catalog dependencies interactively, plus any
# GitHub Actions, Dockerfile, docker-compose, or GitLab CI
# references in the workspace (auto-detected).
vis update --interactive
# Install git hooks
vis hook installInstaller backend (aube)
vis install, vis add, vis remove, vis update, vis dlx, vis exec, vis link, vis unlink, vis dedupe, vis why, vis outdated, vis info, and vis pm honor aube — a Rust-native package manager that reads and writes pnpm/npm/yarn/bun lockfiles in place — as a drop-in installer. Aube also supports the pnpm catalog: and catalog:<name> protocol from pnpm-workspace.yaml, including walk-up resolution from subpackages.
vis does not bundle aube. Install it once via your tool of choice and vis will auto-detect it on PATH:
npm install -g @endevco/aube # or
mise use -g aube # or
brew install endevco/tap/aubeResolution precedence (highest first):
--installer <name>CLI flag —auto,aube,pnpm,npm,yarn, orbun(or--no-aubeto force the lockfile-detected PM for a single run;--no-aubewins over every other source).VIS_INSTALLERenvironment variable — same accepted values as the flag.install.backendinvis.config.ts— same accepted values; the team-wide pin.- Auto-detect —
aubewhen it's onPATHoraube-lock.yamlis present, otherwise the lockfile-detected PM (pnpm-lock.yaml→ pnpm,package-lock.json→ npm,yarn.lock→ yarn,bun.lockb→ bun).
Each step is consulted in order; the first one that resolves to a concrete backend wins. Picking an explicit value (pnpm, npm, …) at any level always beats the auto-detect step below it, so you can override the team default for a single shell session via VIS_INSTALLER=pnpm vis install without touching the config file.
// vis.config.ts — pin the installer for the team
import { defineConfig } from "@visulima/vis/config";
export default defineConfig({
install: { backend: "aube" }, // "auto" | "aube" | "pnpm" | "npm" | "yarn" | "bun"
});Lockfile drift
Aube reuses pnpm/npm/yarn/bun lockfile formats but its serialized output isn't byte-identical to the original tool's. The first install on a workspace whose lockfile was written by another PM produces a one-time churn diff; teams that mix tools on the same lockfile see ongoing drift. vis install warns when this is about to happen — pin install.backend to keep the team consistent.
Lifecycle scripts
Aube already skips dependency lifecycle scripts by default. --ignore-scripts is a no-op under aube (vis install warns when you pass it). To opt specific packages back in, run aube approve-builds — the inverse direction from the pnpm/npm --ignore-scripts model.
Audit delegation
When aube is the active installer, vis audit delegates to aube audit so a single, consistent vulnerability scan runs regardless of entry point. Resolution mirrors the installer chain:
--backend <name>CLI flag —auto,aube, orvis.VIS_AUDIT_BACKENDenv var.security.audit.backendinvis.config.ts.- Defaults to
auto— delegates only wheninstall.backend(orVIS_INSTALLER) resolves to aube ANDaubeis onPATH.
Vis-only features (--report, --fix-transitive, --usage, --policies, --format sarif|csaf|cyclonedx-vex|gitlab|junit, --ecosystem beyond npm) print a warning and are dropped when delegating; pass --backend vis to force the built-in OSV/Socket scanner.
Doctor visibility
When aube is the installer, vis doctor surfaces aube's effective hardening posture (paranoid, trustPolicy, blockExoticSubdeps, jailBuilds, strictDepBuilds, minimumReleaseAge, allowBuilds) alongside the existing vis security.policies.* findings, reading from aube-workspace.yaml (or falling back to pnpm-workspace.yaml). Aube's defaults are already hardened, so most entries render as ok — the section turns into a positive confirmation rather than a wall of warnings.
Commands
| Command | Alias | Description |
| ----------------------- | ------ | -------------------------------------------------------------------------------------- |
| vis create [template] | | Scaffold a new project from templates, npm packages, or git repos |
| vis generate [name] | | Scaffold files from an in-repo template (native TS or moon-format) |
| vis init | | Initialize vis.config.ts with security defaults |
| vis run <target> | | Run a target across workspace projects with caching |
| vis affected <target> | | Run tasks only on projects affected by git changes |
| vis ci <targets> | | One-shot CI entry point: toolchain, install, then affected runs for each comma-separated target |
| vis ignore <project> | | CI build gating for Vercel / Netlify "Ignored Build Step" |
| vis graph | | Visualize the project dependency graph |
| vis check [packages] | c | Check for outdated dependencies in workspace catalogs |
| vis update [packages] | up | Update packages, GitHub Actions, Dockerfiles, and GitLab CI refs |
| vis install | i | Install dependencies via the detected package manager |
| vis info <package> | view | Show npm registry metadata for a package (wraps npm view et al.) |
| vis dlx <package> | | Execute a remote package without permanent installation |
| vis audit | | Audit dependencies for security vulnerabilities |
| vis clean | | Remove build artifacts, caches, and node_modules |
| vis cache <action> | | Inspect cache (list, size, hash, why), or prune / clean |
| vis hook <action> | | Manage git hooks (install, uninstall, migrate) |
| vis secrets [paths] | | Scan for hardcoded secrets / credentials (Rust-native) |
| vis toolchain <cmd> | | Inspect / delegate to the version manager (proto, mise, fnm, volta…) |
| vis lint [files] | | Orchestrate detected source-code linters (oxlint, biome, eslint, stylelint) |
| vis fmt [files] | | Orchestrate detected formatters (oxfmt, biome, dprint, prettier) |
| vis staged | | Run tasks on staged files (built-in lint-staged replacement) |
| vis migrate <type> | | Migrate from other tools — now including gitleaks and secretlint |
For vis ignore, see the command reference and the deployment build gating section of the CI/CD guide.
Diagnosing cache misses
When a task you expected to be cached re-ran, ask vis what changed:
vis cache why @myorg/app:build # human-friendly diff vs. previous run
vis cache why @myorg/app:build --json # stable shape for CI
vis cache hash @myorg/app:build # just print the hash + per-bucket inputsvis cache why reads .vis/last-summary.json and diffs the task's hashDetails (command, nodes, runtime, implicitDeps) against the previous run, so you can pinpoint exactly which bucket rotated. Past runs only land in .vis/runs/ when you pass --summarize, so use vis run :build --summarize (or set it as a default in CI) for diffs you'll want to inspect later.
Cache retention
vis cache prune evicts entries by any combination of age, total size, and count:
vis cache prune --max-age-days=7 # drop entries older than a week
vis cache prune --max-size=2GB # evict oldest until under 2 GB
vis cache prune --keep-last=30 # keep only the 30 newest entries
vis cache prune --keep-last=30 --max-age-days=14 # combine: 30-newest floor, then age cap--keep-last enforces a count floor first (newest-first by mtime), then --max-age-days and --max-size apply.
Sharing the cache across git worktrees
When the workspace is a linked worktree (created with git worktree add), vis stores the cache at <mainWorktreeRoot>/node_modules/.cache/vis so sibling worktrees driven by parallel agents share one cache instead of rebuilding the same hash N times. Set sharedWorktreeCache: false in vis.config.ts to opt out, or use --scope=worktree|shared|all on vis cache list/size/prune to inspect or operate on a specific store.
Quieting successful runs
--output-style=quiet skips stdout/stderr from successful and cached tasks while keeping failures fully visible. Pair it with per-target options.outputStyle to mute a single noisy task — or to keep one critical task verbose under a global quiet flag:
vis run :build --output-style=quiet # only failures print{
"targets": {
"lint": { "options": { "outputStyle": "quiet" } },
"migrate": { "options": { "outputStyle": "normal" } }
}
}See the vis cache and vis run command references for the full surface.
Scanning for secrets
vis secrets wraps @visulima/secret-scanner — a Rust port of the gitleaks detection engine — with ergonomic flags for the common workflows.
vis secrets # scan the workspace (grouped, colourised output)
vis secrets --staged # pre-commit mode: scan staged files only
vis secrets --since main # scan files changed since the `main` branch
vis secrets --affected # scan only files affected by the current branch
vis secrets --init # scaffold an initial .secrets-baseline.json
vis secrets --list-rules # print all bundled detection rules
vis secrets --enable-rule tag:preset:weak-passwords # enable an opt-in rule group additively
vis secrets --exclude 'dist/**' --exclude-from .secretsignore # extra walker exclusions
vis secrets --include-rule stripe-access-token # check a single rule
vis secrets --exclude-rule generic-api-key # drop a noisy rule
vis secrets --baseline .secrets-baseline.json # suppress triaged findings; print diff
vis secrets --update-baseline # merge current findings into the baseline
vis secrets --format sarif > report.sarif # SARIF for GitHub code-scanningSuppression — inline (// gitleaks:allow), block (gitleaks:allow-start … gitleaks:allow-end), or a baseline JSON (sole fingerprint store). See the secret-scanner README for details.
CI example (GitHub Actions, SARIF upload):
name: Secrets
on: [push, pull_request]
jobs:
scan:
runs-on: ubuntu-latest
permissions: { security-events: write, contents: read }
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
- run: pnpm install
- run: pnpm vis secrets --format sarif > report.sarif
continue-on-error: true
- uses: github/codeql-action/upload-sarif@v3
with: { sarif_file: report.sarif }Migrations
vis migrate now speaks two security tools:
vis migrate gitleaks # keeps gitleaks.toml, rewrites scripts/hooks to `vis secrets`
vis migrate secretlint # removes @secretlint/*, rewrites scripts/hooks, notes active rulesEvery destructive step writes a .bak sidecar first and prompts for confirmation (skip with -y). Dry-run previews are available via --dry-run.
Running tasks on staged files
vis staged is a built-in replacement for lint-staged — the same config shape, no peer dependency, and an integrated task renderer. Requires Git ≥ 2.32.
Declare the patterns and tasks under staged in vis.config.ts:
// vis.config.ts
import { defineConfig } from "@visulima/vis/config";
export default defineConfig({
staged: {
"*.{ts,tsx}": ["eslint --fix", "prettier --write"],
"*.md": "prettier --write",
"package.json": (files) => `sort-package-json ${files.join(" ")}`,
},
});Each key is a glob (basename or path-style — path-style matches resolve relative to cwd). Each value is one of:
- a command string — split into argv, invoked with matched files appended;
- a
string[]array — commands run serially for that pattern; - a function
(files) => string | string[] | {title, task}— generate dynamic commands or a custom task; - a
{ title, task }object — runstask(files)with no argv construction, useful for in-process side effects.
vis.config.ts is the single source of truth — no standalone .lintstagedrc* or .vis-staged.* files are read at runtime. Migrating from lint-staged or nano-staged? Run vis migrate lint-staged (or vis migrate nano-staged) to move the config in and remove the legacy files.
Command-line flags
vis staged # run tasks on the current staged set
vis staged --verbose # show stdout/stderr on success as well as failure
vis staged --no-stash # skip the backup stash (faster, but no recovery on failure)
vis staged --diff HEAD~1 # operate on a range instead of `--staged`
vis staged --diff-filter=ACM # override the default ACMR filter
vis staged --concurrent 4 # cap parallel pattern execution
vis staged --continue-on-error # don't short-circuit on the first failure
vis staged --fail-on-changes # non-zero exit if tasks modified staged content
vis staged --hide-unstaged # hide all unstaged edits on tracked files
vis staged --hide-all # hide unstaged edits AND untracked files
vis staged --relative # pass paths relative to cwd to tasks
vis staged --revert # restore pre-task state on failure
vis staged --allow-empty # allow a commit when tasks revert everything
vis staged --auto-stage # auto-stage new files tasks create (codegen, lockfile regen, …)
vis staged --force-kill # kill in-flight tasks with SIGKILL on fast-fail (default: SIGTERM)Environment variables
| Variable | Description |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| VIS_STAGED_CONCURRENT | Concurrency fallback when --concurrent is not passed. Same value shape as the flag (true, false, or an integer). Useful in CI so you don't repeat the flag on every invocation. |
How it behaves
- A hidden backup stash is created (via
git stash create+git stash store, so the working tree is untouched). - For partially-staged files, the unstaged delta is captured as a patch and the working tree is reset to the staged content.
--hide-allextends this to every unstaged change and untracked files via a singlegit stash push --include-untracked. - Tasks run — patterns in parallel (capped at
os.availableParallelism()by default), commands within a pattern serially. - Task-driven edits are re-staged with
git update-index --again(with agit add -ufallback for deletions), so commits made via pathspec (git commit -m "…" .) keep working. - The unstaged patch — or the hide-all stash — is re-applied and the backup stash is dropped on success. On failure without
--revert, the backup stash is preserved and the recovery sha is surfaced to the user. Ctrl+C aborts in-flight commands and still runs the restore path; a second Ctrl+C exits immediately.
Migrating from lint-staged
vis migrate lint-staged # moves the config into vis.config.ts and rewrites hooksThe migrator detects package.json keys, .lintstagedrc* files, and lint-staged.config.*, prompts before rewriting husky/vis hooks to call vis staged, and removes lint-staged from the dependency list.
Configuration API
The @visulima/vis/config subpath export is the programmatic surface for typed config and the plugin system. It ships more than defineConfig:
| Export | Kind | Purpose |
| ---------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------ |
| defineConfig | function | Type-checked vis.config.ts helper (root config). |
| defineTaskConfig | function | Type-checked task-only config (vis.task.config.ts). |
| definePlugin | function | Author a vis plugin (hooks, fingerprint contributors, OTel, …). |
| otelPlugin | function | Built-in OpenTelemetry plugin factory. |
| loadVisConfig / loadVisTaskConfig | function | Resolve + load the config from disk programmatically. |
| findVisConfigFile / findVisTaskConfigFile | function | Locate the config file without loading it. |
| applyDefaults | function | Merge a partial config with vis defaults. |
| CONFIG_FILES / TASK_CONFIG_FILES | const | The recognised config filenames, in resolution order. |
| SECURITY_DEFAULTS | const | The default audit/security policy applied when none is configured. |
| VisConfig, VisTaskConfig, VisPlugin, VisHooks, OtelPluginOptions, FingerprintContributor | type | Public config & plugin types. |
import { defineConfig, definePlugin, otelPlugin } from "@visulima/vis/config";
const auditLogger = definePlugin({
name: "audit-logger",
hooks: {
"task:after": (task, result) => {
console.log(`${task.id} finished with exit code ${result.exitCode}`);
},
},
});
export default defineConfig({
plugins: [auditLogger, otelPlugin({ serviceName: "my-monorepo" })],
});See docs/configuration.mdx for the full config model and docs/guides/plugins.mdx for the plugin authoring guide. A @visulima/vis/generate subpath export is also available for programmatic scaffolding.
Documentation
For full documentation including command reference, configuration options, best practices, and CI/CD integration guides, see the docs folder.
Supported Node.js Versions
Libraries in this ecosystem make the best effort to track Node.js' release schedule. Here's a post on why we think this is important.
Contributing
If you would like to help take a look at the list of issues and check our Contributing guidelines.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Credits
Migration sources
vis migrate ports configuration, scripts, and hooks from the following projects. Huge thanks to their authors and maintainers for the prior art that shaped vis's surface area.
| Project | Migrates with | Replaces |
| ---------------------------------------------------------- | ------------------------- | --------------------------- |
| Husky | vis hook migrate | Git hook manager |
| lint-staged | vis migrate lint-staged | Pre-commit task runner |
| nano-staged | vis migrate nano-staged | Pre-commit task runner |
| Turborepo | vis migrate turborepo | Monorepo task runner |
| Nx | vis migrate nx | Monorepo task runner |
| Moon | vis migrate moon | Monorepo task runner |
| Gitleaks | vis migrate gitleaks | Secret scanner |
| Kingfisher | vis migrate kingfisher | Secret scanner (MongoDB) |
| Secretlint | vis migrate secretlint | Secret linter |
| Syncpack | vis migrate syncpack | Workspace dependency policy |
| Sherif | vis migrate sherif | Monorepo linter |
After migrating a task runner, run vis migrate verify-graph to prove the migration preserved the task graph and cache-key surface — it diffs the original turbo / nx / moon config against the generated vis.config.* across six axes (target set, dependsOn, inputs, outputs, env, cache) and exits non-zero on any dropped task or narrowed cache key, so it can gate CI.
Made with ❤️ at Anolilab
This is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. Anolilab is a Development and AI Studio. Contact us at [email protected] if you need any help with these technologies or just want to say hi!
License
The visulima vis is open-sourced software licensed under the MIT
