@retter/rio-cli

Retter.io Command Line Tool

Rio CLI is a command-line tool that allows you to interact with the RIO platform. You can use it to deploy your RIO projects, generate class files, create new projects, and more.

Installation

npm i -g @retter/rio-cli

Commands

rio --

• --help: Show help.
• --version: Show version number.

rio set-profile [sp]

Upsert admin profile in local storage.

rio set-profile --profile-name myProfile --secret-id mySecretId --secret-key mySecretKey --endpoint myRioDomain

Arguments

• --profile-name: Name of this admin profile
• --secret-id: Secrect id fetched from console
• --secret-key: Secrect key fetched from console
• --endpoint: URL to target rio console

rio deploy [d]

Save local changes and deploy the project.

Arguments

• --profile [p]: Profile name for deployment (type: string)
• --project-id [pid]: Project id for deployment (type: string).
• --classes [c]: Filtered classes for deployment (type: array) (optional).
• --ignore-approval [i]: Ignore deployment manual approval (optional).
• --force [f]: Send deployment requests with force parameter to RIO (optional).
• --skip-diff-check [s]: Skip and don't perform difference checks while deploying (optional).

rio deploy --profile admin --project-id 77bb3924k --classes Order Product --force --skip-diff-check --ignore-approval
rio d --p admin --pid 77bb3924k --c Order Product --f --s --i

rio save [s]

Save local changes to but do not deploy the project.

Arguments

• --profile [p]: Profile name for deployment (type: string)
• --project-id [pid]: Project id for deployment (type: string).
• --classes [c]: Filtered classes for deployment (type: array)(optional).
• --ignore-approval [i]: Ignore deployment manual approval (optional).
• --skip-diff-check [s]: Skip and don't perform difference checks while deploying (optional).

rio save --profile admin --project-id 77bb3924k --classes Order Product --skip-diff-check --ignore-approval
rio s --p admin --pid 77bb3924k --c Order Product --s --i

rio init [alias] (i)

Create a new project.

rio init myProject

rio list-profiles [lp]

List local admin profiles.

rio list-profiles

rio generate [g]

Generate RIO class files.

rio generate

rio generate-docs [gd]

Generate project documentation.

rio generate-docs

rio console [con]

Open project console.

rio console