playbooks

home / skills / desplega-ai / ai-toolbox / install

install skill

/cc-plugin/file-review/skills/install

This skill guides you through installing the file-review tool on a new machine and setting it up quickly.

npx playbooks add skill desplega-ai/ai-toolbox --skill install

Review the files below or copy the command above to add this skill to your agents.

Files (1)
SKILL.md
295 B
---
name: file-review-install
description: Install the file-review tool. Use when user needs to install file-review on a new machine or asks how to set it up.
---

# Install File Review

Thin redirect. Follow the **Install** section of the `file-review:file-review` skill for full instructions.

Overview

This skill installs the file-review tool and prepares it for local use on a new machine. It provides clear, practical steps to get the tool running either via package manager or from source. Use it when you need a fast, repeatable setup for agents or developer workflows.

How this skill works

The skill guides you through prerequisites (Node.js and a package manager), then shows both package-based and source-based installation paths. It explains how to build TypeScript sources, link the CLI for development, and verify the installation with a quick command. It focuses on minimal, reproducible steps so agents and humans can start using file-review right away.

When to use it

  • Setting up a new developer machine or CI runner to run file-review
  • Onboarding an agent that needs file-review available globally or in a project
  • Installing from source when you want to modify or debug the tool
  • Installing via package manager for a quick, stable setup

Best practices

  • Install a recent LTS Node.js version (16+ or the current LTS) to avoid runtime issues
  • Prefer a project-local install (devDependency) for reproducible builds in CI
  • Use a package manager you already use (npm, yarn, or pnpm) and commit lockfiles for CI reproducibility
  • When working from source: run the build step and use a local link (npm link or pnpm link) to test changes before publishing
  • Verify installation with the CLI help command to confirm the binary is on PATH

Example use cases

  • Quickly add file-review to a project’s devDependencies and run it in CI to enforce file checks
  • Clone the source, make TypeScript fixes, build, and link the CLI to test local changes
  • Install globally on a developer laptop for ad-hoc file inspections and agent testing
  • Add file-review to a container image during CI image build so agents have the tool available at runtime

FAQ

What Node.js version is required?

Use a current LTS release (Node 16 or newer) to ensure compatibility with modern TypeScript tooling.

Can I run file-review without installing globally?

Yes. Install it as a project devDependency and run it via npx or an npm script, or use a linked local install during development.