Skip to content

Vnoxco/monocli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MonoCLI

MonoBill's official CLI for theme and app development. This command line tool comes with handy features like automatic file uploads for website themes, running your app locally for easier development.

Table of contents

Install on Windows
Install on Mac
Commands


Install on Windows

Requirements

  • Chocolatey
  • NodeJS
  • PHP (if using laravel app)
  • Composer (if using laravel app)
  • Ngrok

Steps:

  1. Download and install chocolatey, follow the instructions here: https://chocolatey.org/install
  2. Install NodeJs from https://nodejs.org/en/download
  3. Install ngrok https://ngrok.com/download
  4. (if using Laravel app) Install php by running choco install php
  5. (if using Laravel app) Install composer from https://getcomposer.org/download/
  6. (if using Laravel app) Edit php.ini and change ;extension=zip to extension=zip and ;extension=fileinfo to extension=fileinfo
  7. Install MonoCLI npm install -g @ron-vnox/monocli

Install on Mac

Requirements

  • Homebrew
  • NodeJS
  • PHP (if using laravel app)
  • Composer (if using laravel app)
  • Ngrok

Steps:

  1. Download and install Homebrew /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  2. Install NodeJs brew install node
  3. Install ngrok https://ngrok.com/download
  4. (if using Laravel app) Install php by running brew install php
  5. (if using Laravel app) Install composer by running brew install composer
  6. (if using Laravel app) Edit php.ini and change ;extension=zip to extension=zip and ;extension=fileinfo to extension=fileinfo
  7. Install MonoCLI npm install -g @ron-vnox/monocli

NB - If you are using the Laravel + Vue application, Vite will only work if you view the app from the same machine you are serving the app from. Vite runs on localhost.

Commands

mono auth login
mono auth logout
mono auth who

mono theme download [id]
mono theme list
mono theme open
mono theme upload
mono theme watch

mono app init [dir]
mono app serve

mono store list

mono auth login

USAGE
  mono auth login

DESCRIPTION
  Login using your MonoBill account.

mono auth logout

USAGE
  mono auth logout

DESCRIPTION
  Logout of your current session and delete the access token.

mono auth who

USAGE
  mono auth who

DESCRIPTION
  Shows which MonoBill account is currently authenticated.

mono theme download [id]

USAGE
  mono theme download [id]

DESCRIPTION
  Download a theme by ID.
  If the working directory is a MonoBill theme and the config file is present, the ID is not required.

mono theme list

USAGE
  mono theme list

DESCRIPTION
  Download a theme by ID.
  List all themes on your MonoBill account, development themes and themes installed on stores.

mono theme open

USAGE
  mono theme open

DESCRIPTION
  Open the theme in preview mode

mono theme upload

USAGE
  mono theme upload

DESCRIPTION
  Uploads all files in the current theme directory.

OPTIONS:
      --id       ID of the theme to upload                              [number]
  -s, --store    Store ID for upload                                    [string]

mono theme watch

USAGE
  mono theme watch

DESCRIPTION
  Watch directory for file changes and upload file automatically.

OPTIONS:
  -f, --force    Force the command to execute                          [boolean]

mono app init [dir]

USAGE
  mono app init [dir]

DESCRIPTION
  Initialize an app, downloading the latest example app from GitHub and setting the basic configurations.

OPTIONS:
  --type     Type of application, [laravel-vue]                     [string] [default: "laravel-vue"]
  --dir      Directory of which the app should be initialized       [string]
  -f, --force    Force the command to execute                       [boolean]

mono app serve

USAGE
  mono app serve

DESCRIPTION
  Start development processes and open a tunnel

OPTIONS:
  --tunnel      Specify the tunnel software to use. [ngrok]           [string] [default: "ngrok"]
  --tunnel-url  Specify the url that the tunnel should run on.        [string] [required]
  --app-port    Specify the port that the app should run on locally.  [number] [default: 8001]

mono store list

USAGE
  mono store list

DESCRIPTION
  List all stores on your MonoBil account, development stores and live stores.

Releases

No releases published

Packages

No packages published