Back to docs

Install and first run

Set up agentshorts locally and run the first validation pass.

setup · 2026-05-12

agentshorts is delivered as a private product repository plus optional module repositories. The exact repository URL depends on the tier and modules purchased.

Prerequisites

  • Node.js 20 or newer.
  • Git configured with the GitHub account used at checkout.
  • Access to the private agentshorts repository invitation.
  • Provider API keys for the services you choose to enable.
  • A local terminal that can run npm scripts.

Install

1. Accept the GitHub repository invitation from the purchase email. 2. Clone the product repository. 3. Run npm install from the repository root. 4. Copy the provided environment example to your local environment file. 5. Fill only the providers you plan to test first. 6. Run the validation script documented in the repository README.

First run

Start with a dry run or sample fixture before connecting production channels. Confirm the pipeline can read source inputs, write output files, and print a license warning or success message without crashing.

If a module is installed, read that module README before enabling it in the main pipeline. Modules may require separate provider credentials, queue configuration, or account approval.

Safety checks

Never paste secrets into support email. If you need help, send the command, redacted output, module name, operating system, and license key prefix only.

Install and first run — agentshorts