sp-shell

SpacePortal Shell

Overview

Interact with SpacePortal through CLI.

Installation

To install the CLI globally, run:

npm install -g spaceportal-shell

For local development, clone the repository and link it:

git clone <repository-url>
cd sp-shell
npm install
npm link

Usage

Commands

sp login

Authenticate a user with their identity.

sp login

sp logout

Terminate the current user session.

sp logout

sp register

Register a new user.

sp register

This command will prompt you to enter your email and password to register a new user.

sp config

Display current configuration.

sp config

sp status

Check current session status.

sp status

sp api <namespace>.<method>.v<version> [params...]

Invoke a SpacePortal API method with specified parameters.

sp api user.auth.login.v1 identity.type=email identity.value=[e-mail] credential.type=password credential.value=examplepassword

sp console

Open the admin console in the default browser.

sp console

sp shell

Start an interactive shell (REPL) for executing SpacePortal API commands interactively.

sp shell

Debug Mode

Enable debug mode to print all requests and responses for better visibility.

Add the --debug flag to any command to enable debug mode:

sp login --debug

In the REPL, you can start the shell with debug mode by running:

sp shell --debug

Error Handling

The CLI handles errors gracefully and provides meaningful error messages. If debug mode is enabled, detailed logs of the requests and responses are printed to the console.

License

This project is licensed under the MIT License.