Installation and CLI
This page explains how to install RayQuiro, how modules are installed in 0.0.2, and what the current rqio command set looks like.
Install RayQuiro
Install from the release flow
irm https://raw.githubusercontent.com/Raytolfas/RayQuiroAssets/main/install.ps1 | iex
The installer:
- downloads
update.json - resolves
downloadUrlordownload_url - downloads
rqio.exe - installs it into
C:\rayquiro\bin - adds
C:\rayquiro\binto the userPATH
After installation:
rqio version
Build the CLI from source
From the RayQuiro repository root:
./build.ps1
Current CLI Commands
The normal rqio help surface in 0.0.2 is:
rqio <script.rq>rqio run <script.rq>rqio run --vm <script.rq>rqio pack <script.rq> [-o out.rqb]rqio bundle <script.rq> [-o out-dir]rqio build-vm <script.rq> [-o out-dir]rqio <bundle.rqb>rqio fmt <script.rq>rqio init [project-folder]rqio framework install <owner/repo[@branch]> [--local]rqio framework install <approved-name> [--local]rqio install <approved-name> [--local]rqio install rayquiro.<module> [--local]rqio self-update [check]rqio versionrqio helprqio build <script.rq> [-o out.exe]
What Each Command Is For
rqio file.rq
Runs a RayQuiro file through the normal runtime.
rqio run file.rq
Explicit run form.
rqio run --vm file.rq
Runs a supported script through the RayQuiro VM.
rqio pack file.rq
Creates a .rqb bytecode package.
rqio bundle file.rq
Creates a distributable bundle directory for the VM path.
rqio build-vm file.rq
VM bundle alias.
rqio build file.rq
Builds a Windows executable.
In 0.0.2, normal build flow no longer presents generated C++ as a user-facing project artifact.
rqio fmt file.rq
Formats a RayQuiro source file.
rqio init my-app
Creates a starter project with:
rqproject.jsonmain.rq.rq_modules/build/.gitignore
rqio framework install ...
Installs a source framework from GitHub or by approved name.
rqio install telebot
Installs an approved source framework from the registry.
rqio install rayquiro.<module>
Installs an official native module such as:
rayquiro.webrayquiro.uirayquiro.apprayquiro.engine
rqio self-update
Checks for and installs a newer runtime release.
Installing Official RayQuiro Modules
Install globally:
rqio install rayquiro.web
rqio install rayquiro.ui
rqio install rayquiro.app
rqio install rayquiro.engine
Install into the current project:
rqio install rayquiro.engine --local
Official native modules are distributed from:
https://github.com/Raytolfas/RayQuiroAssets/tree/main/modules
Installing Source Frameworks
Install directly from GitHub:
rqio framework install RayQuiro/Telebot
rqio framework install RayQuiro/Telebot@main
rqio framework install RayQuiro/Telebot --local
Install by approved registry name:
rqio install telebot
rqio install telebot --local
Registry source:
https://raw.githubusercontent.com/Raytolfas/RayQuiroAssets/main/frameworks.json
Output And Module Directories
build/
Typical output:
.exe.html.rqb- bundle directories
.rq_modules/
Project-local frameworks and native modules.
Typical shape:
.rq_modules/
telebot/
native/
web.dll
ui.dll
app.dll
engine.dll
User-level locations
Typical Windows user-level locations:
%USERPROFILE%/.rqio/frameworks%USERPROFILE%/.rqio/modules
Machine-level module target
Official machine-level Windows module location:
C:\Program Files\RayQuiro\modules
rqproject.json
Supported keys documented for 0.0.2:
nameversionentrybuild_dir
Example:
{
"name": "my-app",
"version": "0.0.2",
"entry": "main.rq",
"build_dir": "build"
}
Toolchain Note
rqio build still uses a native toolchain internally.
That affects the native build path, but it does not change the public runtime shape of:
- direct
rqio file.rq - the VM path
.rqbpackagingbundle- module installation