README

This repository contains a composer project to setup a rose-core command line interface to run your .fn files, create projects, and more stuff! Right from the comfort of your terminal.

Installation

First and foremost, ensure you have PHP 8.1+ and Composer 2+ installed in your system and that those are reachable via PATH.

Open a terminal and navigate to the folder where you want rose-cli to be installed and execute the following commands:

composer create-project rsthn/rose-cli
cd rose-cli
composer update
./install

After that, the command rose should be globally accessible.

Removal

Automatic removal is currently not supported, but to remove it manually simply execute where rose / whereis rose / which rose to locate the rose.sh or rose.bat file that was created in the PHP folder and remove it. Then remove the entire rose-cli folder and that is all.

Commant Line Interface

Create a new API project in the specified folder.

rose new [target-folder]

Runs the specified file.

rose example.fn [args...]

Executes the given code immediately.

rose -i "(echo 'Hello')"

Throws an error if the operator returns false when evaluated with the rose-core version.

rose version ge? 1.0.0

Shows the rose-core and CLI versions.

rose version

Shows a list of all installed packages.

rose ls

Installs a package using composer.

rose add <package-name>

Removes a package.

rose rm <package-name>

Updates all packages or an specific package.

rose up [package-name]

Pulls a repository of CLI modules in the module cache. If no repository is specified, the default one (rose-cli-mods) will be used

rose mod-pull [repo-path|repo-url]

Shows all available modules in the module cache.

rose mod-search

Shows a list of installed modules.

rose mod-ls

Installs a module.

rose mod-add <mod-name>

Removes a module.

rose mod-rm <mod-name>

Executes a module with the specified parameters.

rose :mod-name [args..]

rsthn / rose-cli

Maintainers

Details

README

Installation

Removal

Commant Line Interface