JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q53620F
  • License MIT

SlimIO Command Line Interface

Package Exports

  • @slimio/cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@slimio/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CLI

version Maintenance MIT

SlimIO Command Line Interface. This tool has been created to help Developer and Integrator to work, design and scale the product easily.

Requirements

  • Node.js version 10 or higher
  • Administrative privilege for some commands.

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/cli
# or
$ yarn add @slimio/cli

If you want to download private SlimIO package, create a local .env file with the following content:

GIT_TOKEN=

If you dont known how to get a personal access token, please check this guide.

Usage Exemple

$ npm slimio --help
# or
$ npm slimio -h

API

Example :

$ slimio <command> <value>
Command & Shortcut Type Default value Description
init string agent Initialize a new SlimIO Agent
add string Add an addon to the agent
create Create bunch of files for the agent
service string add Create an agent service
connect String localhost:1337 Connect CLI to a local or remote SlimIO Agent
build boolean false Bundle/Build Core & SlimIO Addons
--addons array [] Additionals addons for init command
--type string core Bundle/Build type for build command

init

Default value: agent

Initialize a new SlimIO Agent:

  • Install Agent folder
  • Install Built-in addons

The value define the name of the agent folder

--add

Add an addon to the agent with the name or an Url from github. Currently, it's only take from SlimIO organization.

--create

You must be in an agent folder !

Create bunch of files for the agent:

  • Addon: default addon for a developper
  • Manifest: file configuration for SlimIO projects
--service

You must be in an agent folder ! Default value: add

Create a service of the Agent

Command Description
add Add SlimIO Agent service
rm Remove SlimIO Agent service
--connect, -c

Default value: localhost:1337

Connect CLI to a local or remote SlimIO Agent:

Command Description
addons Call a callback from an addon
create Create bunch of files for the agent
help Show all commands
quit Exit agent connection

Dependencies

Name Refactoring Security Risk Usage
@slimio/addon-factory Minor Low Addon default initializer
@slimio/arg-parser Minor Low Command line parser
@slimio/async-cli-spinner Minor Low Multi Cli Spinner
@slimio/github Minor High Github API
@slimio/lazy Minor Low Lazy loader
@slimio/manifest Minor Low Manifest
@slimio/pretty-json Minor Low JSON CLI beautifer
@slimio/tcp-sdk Minor Low TCP sdk
@slimio/utils Minor Low Bunch of useful functions
dotenv ⚠️Major Low Env file
kleur ⚠️Major Low CLI color
make-promises-safe ⚠️Major Medium Force Node.js DEP00018
os-service ⚠️Major High Services manager
qoa ⚠️Major Low Interactive CLI prompt

Recheck !

License

MIT