Skip to content
Figranium logo

Installation via NPM (Package)

This guide covers installing figranium as a standalone NPM package. This is ideal for quickly testing figranium without cloning the repository or u...

Prerequisites#

  • Node.js (LTS recommended, v18+).
  • NPM or Yarn installed.

To install figranium globally:

npm install -g figranium

Running the CLI#

Once installed, you can start the application using:

figranium

This will launch the figranium server on the default port (11345).

Access the Application#

Open your browser and navigate to:

http://localhost:11345

Running with NPX (Temporary/One-Off)#

If you don't want to install figranium globally, you can run it directly using npx:

npx figranium

This will execute the latest version of figranium without a global installation.

Customizing Configuration#

You can customize the environment variables by passing them before the command:

PORT=8080 SESSION_SECRET=mysecret figranium

Or with npx:

PORT=8080 SESSION_SECRET=mysecret npx figranium

Running Scripts (Advanced)#

The NPM package also exposes specific scripts for different modes:

  • Scraper Mode: figranium --scrape (Runs the high-performance scraper).
  • Agent Mode: figranium --agent (Runs the full automation agent).

Additionally, you can run a debugging session:

  • Headful Execution: figranium --headful (Opens the interactive browser for debugging).

For more details on CLI usage, see CLI Tool Documentation.

Previous
Next