Skip to main content
Version: 7.2

Raaghu CLI

Raaghu CLI (Command Line Interface) is a command line tool to perform some common operations for Raaghu based solutions.

Installation​

Raaghu CLI is a dotnet global tool. Install it using a command line window:

dotnet tool install -g Waiin.Raaghu.Cli
dotnet tool install --global Waiin.Raaghu.Cli

To update an existing installation:

dotnet tool update -g Waiin.Raaghu.Cli
dotnet tool update --global Waiin.Raaghu.Cli

Commands​

Here, is the list of all available commands before explaining their details:

  • help: Shows help on the usage of the Raaghu CLI.
  • new: Generates a new solution based on the Raaghu.
  • generate: Generates client side proxies to use HTTP API endpoints.
  • create: Create is used to generate different types of pages for managing data relationships.
  • add: Add helps us for creation of new pages, components, and elements without entity data.
  • sync: Helps us to connect frontend to ABP backend microservices source code solution.
  • login: Authenticates on your computer with your raaghu.io email and password.
  • login --info: Shows the current user's login information.
  • logout: Logouts from your computer if you've authenticated before.

help​

Shows basic usages of the Raaghu CLI.

Usage:

raaghu help

Examples:

raaghu help        # Shows a general help.
raaghu help new    # Shows help about the "new" command.

new​

Generates a new solution based on the Raaghu.

Usage:

raaghu new <solution-name> [options]

Example:

raaghu new Raaghu.BookStore
  • Raaghu.BookStore is the solution name here.
  • The common convention for naming a solution is like "YourCompany.YourProject." However, you can use different naming conventions such as "YourProject" (single-level namespacing) or "YourCompany.YourProduct.YourModule" (three-level namespacing).

For more samples, go to Raaghu CLI Create Solution Samples

Options​

  • --version or -v: Specify the Raaghu version. If the version is not specified, it will automatically use the latest version to create the solution.
raaghu new <solution-name> --version <version>
raaghu new <solution-name> -v <version>

Example:

raaghu new Raaghu.BookStore  --version 7.4.4
raaghu new Raaghu.BookStore  -v 7.4.4

generate​

Generates service proxies for your HTTP APIs to make easy to consume your services from the client side. Your host (server) application must be up and running before running this command.

Usage:

raaghu generate [options]

options​

  • --proxy : Used for connection.
    • -t or --template : Used to create the application template proxy.
    • -m or --microservices : Used to create the microservices proxy.

Example:

raaghu generate --proxy -t
raaghu generate --proxy --template
raaghu generate --proxy -m
raaghu generate --proxy --microservices

create​

Create is used to generate different types of pages for managing data relationships.

  • First you need to run the Slice command to create the differnt types of crud pages :
raaghu create --Slice

To create different types of pages use the following commands:​

  • create --CRUDPage: Makes a page for managing data (like adding, viewing, updating, and deleting).which checks relationships and execute accordingly.

Usage:

raaghu create --CRUDPage
  • create --SimplePage: Creates a basic page, which do have any relation or dependancy on other page.

Usage:

raaghu create --SimplePage
  • create --OneToMany: Creates a page for handling one to many related entities.

Usage:

raaghu create --OneToMany
  • create --ManyToMany: Creates a page for handling many to many related entities.

Usage:

raaghu create --ManyToMany
  • create --HybridMany: Creates a page for handling a mix of different relationships.

Usage:

raaghu create --HybridMany

add​

Add helps us for new creation of pages, components, and elements without entity data.

  • Create new Component : To create a component without associated entity data, use the following command: Usage:
raaghu add --component
raaghu add -c
  • Create new Element : To create a element without associated entity data, use the following command: Usage:
raaghu add --element
raaghu add -e
  • Create new Page : To create a page without associated entity data, use the following command: Usage:
raaghu add --page
raaghu add -p

sync​

Helps us to connect frontend to ABP backend microservices source code solution.

Usage:

raaghu sync [options]

options​

  • --abp : Connect frontend to ABP Commercial solution.
    • --microservices or -m : ABP backend microservices source code solution.

Example:

raaghu sync --abp --microservices
raaghu sync --abp -m

login​

Some features of the CLI requires to be logged in to raaghu.io platform. To login with your email write:

raaghu login              #Allows you to enter your email and password(hidden)

A new login with an already active session overwrites the previous session.

  • login --info:

Shows your login information such as email .

raaghu login --info

logout​

Logs you out by removing the session token from your computer.

raaghu logout