cliston

ALLOHOUSTON CLI

Install

The easiest way to install the cli is to use npm link locally. You just need to clone the repository and checkout the right branch/commit you want to use. Then you can run the following commands at the root of this repository:

npm link

# Table of content

<!-- toc -->
* [Install](#install)
* [Table of content](#table-of-content)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @suprakit/cli
$ cliston COMMAND
running command...
$ cliston (-v|--version|version)
@suprakit/cli/0.0.2 darwin-arm64 node-v18.20.3
$ cliston --help [COMMAND]
USAGE
  $ cliston COMMAND
...

Commands

• cliston help [COMMAND]
• cliston meteor
• cliston meteor:api
• cliston meteor:component
• cliston meteor:create-app
• cliston meteor:form
• cliston meteor:page

cliston help [COMMAND]

display help for cliston

USAGE
  $ cliston help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cliston meteor

The meteor command is a topic for Meteor Tools

USAGE
  $ cliston meteor

DESCRIPTION
  ...

cliston meteor:api

Creates a new Meteor api-v2 folder with state-of-the-art configuration

USAGE
  $ cliston meteor:api

DESCRIPTION
  ----------------------------------------
  > Creating meteor api folder and files
  ----------------------------------------
  This command will :
  - Create the folder and pre-filled files for a new meteor api-v2 inside the imports/api folder
  ** Note: You need to be at the root of your meteor project

See code: src/commands/meteor/api.ts

cliston meteor:component

Creates a new Meteor Template folder with state-of-the-art configuration

USAGE
  $ cliston meteor:component

DESCRIPTION
  -------------------------------------------
  > Creating meteor react template folder and files
  -------------------------------------------
  This command will:
  - Create the folder and pre-filled files for a new meteor react template

See code: src/commands/meteor/component.ts

cliston meteor:create-app

Creates a new Meteor Application using the StarterKit

USAGE
  $ cliston meteor:create-app

DESCRIPTION
  -------------------------------------------------------
  > Creating a new meteor app from the starterkit meteor
  -------------------------------------------------------
  This command will :
  - Pull the last version of the starterkit for react
  - Make the necessary changes to the git config
  - Create all the branches used usually (dev/preprod/prod)
  - Reset the commits and README
  - Push to the github project given when prompted


  TODO:
  [ ] Select default login mode
  [ ] Select defaults packages added
  [ ] Ability to customize branches used ?
  [ ] ?

See code: src/commands/meteor/create-app.ts

cliston meteor:form

Creates a new Meteor formik form file with state-of-the-art configuration

USAGE
  $ cliston meteor:form

DESCRIPTION
  -------------------------------------------
  > Creating meteor react formik form file
  -------------------------------------------
  This command will:
  - Create the pre-filled file for a new meteor react formik form

See code: src/commands/meteor/form.ts

cliston meteor:page

Creates a new Meteor page folder with state-of-the-art configuration

USAGE
  $ cliston meteor:page

DESCRIPTION
  -------------------------------------------
  > Creating meteor react page folder and files
  -------------------------------------------
  This command will:
  - Create the folder and pre-filled files for a new meteor react page

See code: src/commands/meteor/page.ts