📟

Eyas CLI

For Developers

Bundle your web application from any branch and share it with stakeholders for hands-on testing — before merging. No deployment required.

NPM Version

Install

npm install @cycosoft/eyas --save-dev
View on NPM → View on GitHub →

How It Works

  1. 1

    Install

    Add the CLI to your project as a dev dependency, as shown above.

  2. 2

    Configure

    Optionally add a .eyas.config.js to your project root. Common options include:

    • source — path to your build output directory (default: dist/)
    • domains — domain(s) to proxy for API calls during testing
    • outputs.expires — how long before the test expires, in hours (default: 168)

    View the full configuration reference →

  3. 3

    Build & Share

    Run after your normal build command to produce a shareable test artifact.

    npm run build && npx eyas file --open

Output Types

npx eyas file

Generates a .eyas file. Share it directly with testers — they open it in Eyas Desktop.

✅ Requires Eyas Desktop

npx eyas web

Outputs an eyas.json to your build directory. Deploy to any web server and share the link with testers.

✅ Requires Eyas Desktop