Setup

Installation Guide

Prepare your system for XyPriss development by installing the mandatory ecosystem tools.

System Requirements

Before running a XyPriss project, ensure the following tools are installed. They are mandatory — using alternative package managers (npm, yarn, pnpm) or runtimes may cause unexpected behavior and is not supported.

Requirement	Purpose	Install Source
XFPM	The exclusive package manager for the XyPriss ecosystem. Handles native core linking.	See below
Bun	The primary JavaScript runtime used to execute XyPriss projects and high-speed scripts.	bun.sh

Installing the CLI

The unified installer automatically detects your OS and architecture to install the correct XFPM binary.

Linux & macOS

bash

curl -sL https://xypriss.nehonix.com/install.js | node

Windows (PowerShell)

powershell

Invoke-WebRequest -Uri https://xypriss.nehonix.com/install.js -OutFile install.js; node install.js; Remove-Item install.js

Runtime Restrictions

Starting a XyPriss server with npm run, node, or other unsupported runtimes may produce undefined behavior. Always use xfpm run to execute scripts and entry points.

Installing XyPriss Core

After configuring the CLI environment, you can add the XyPriss core engine to any project directory:

bash

xfpm install xypriss # This will install the XyPriss core engine in your current project

XyPriss Security Shield

For projects requiring advanced protection, install the optional security shield:

bash

xfpm install xypriss-security

Verification

Once installed, verify that the CLI is available in your PATH:

bash

xfpm --version

Troubleshooting

Permission Denied

If you encounter an EACCES error on Linux/macOS, you may need to manually grant write permissions or run the command with elevated privileges:

bash

sudo xfpm [command]

PowerShell Policy

On Windows, if the script is blocked, enable local script execution:

powershell

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Ready to code?

Now that your environment is configured, you can initialize a new project from a template and start building.