vaah

v3.2.5

Published

a month ago

CLI of VaahCMS - VaahCLI

Downloads

587

0High
0Medium
0Low

webreinvent

vaah vaahcli

Vaah

Command line tool to Generate Files for Rapid Development

Please consider starring the project to show your :heart: and support.

Feature Roadmap

Completed

:white_check_mark: VaahCMS Installer

:white_check_mark: VaahCMS Module Generator

:white_check_mark: VaahCMS Module CRUD Generator

:white_check_mark: VaahCMS Theme Generator

:white_check_mark: VaahCMS Theme Auth Generator

:white_check_mark: VaahCMS Modules Files (migration, model, view, controller, seed )

:white_check_mark: VaahCMS Themes Files (migration, model, view, controller, seed )

Planned

:black_square_button: Laravel Package Development

:black_square_button: Laravel Files (migration, model, view, controller, seed )

:black_square_button: WordPress Theme

:black_square_button: WordPress Plugin

Install

Install with npm:

npm install -g vaah

Quick Command Generator

VaahCms Installer

vaah cms:install or npx vaah cms:install : It will install vaahcms in newly created vaahcms folder
vaah cms:install [FOLDER] : To install VaahCMS
vaah cms:install --here : To install VaahCMS in current director

VaahFlutter Installer

vaah flutter:install or npx vaah flutter:install : It will install VaahFlutter in newly created vaahflutter folder

VaahCms Module Generators

List of commands:

vaah cms:m or npx vaah cms:m : To generate module
vaah cms:crud or npx vaah cms:crud : To generator crud operation file for module
vaah cms:users or npx vaah cms:users : Vue 3: To Generate Users CRUD operations for VaahCMS
vaah cms:taxonomies or npx vaah cms:taxonomies : Vue 3: To Generate Taxonomies CRUD operations for VaahCMS
vaah cms:settings or npx vaah cms:settings : Vue 3: To Generate Setting for VaahCMS

All following commands accept option parameter -f <folder_name> or -folder <folder_name>

vaah cms:m-make migration <module> <name> : To generate module migration
vaah cms:m-make seed <module> <name> : To generate module seed
vaah cms:m-make model <module> <name> : To generate module model
vaah cms:m-make controller <module> <name> : To generate module controller
vaah cms:m-make view <module> <name> : To generate module view
vaah cms:m-make middleware <module> <name> : To generate module middleware
vaah cms:m-make observer <module> <name> : To generate module observer
vaah cms:m-make trait <module> <name> : To generate module trait
vaah cms:m-make test <module> <name> : To generate module browser test
vaah cms:m-make event <module> <name> : To generate module events
vaah cms:m-make listener <module> <name> : To generate module listener
vaah cms:m-make mail <module> <name> : To generate module email
vaah cms:m-make notification <module> <name> : To generate module notification

VaahCms Theme Generators

List of commands:

vaah cms:t or npx vaah cms:t : To generate theme
vaah cms:auth or npx vaah cms:auth: Generate Sign in & Sign up, authentication scaffolding

All following commands accept option parameter -f <folder_name> or -folder <folder_name>

vaah cms:t-make migration <theme> <name> : To generate theme migration
vaah cms:t-make seed <theme> <name> : To generate theme seed
vaah cms:t-make model <theme> <name> : To generate theme model
vaah cms:t-make controller <theme> <name> : To generate theme controller
vaah cms:t-make view <theme> <theme> : To generate theme view
vaah cms:t-make middleware <theme> <name> : To generate theme middleware
vaah cms:t-make observer <theme> <name> : To generate theme observer
vaah cms:t-make trait <theme> <name> : To generate theme trait
vaah cms:t-make test <theme> <name> : To generate theme browser test

Laravel Generators

Laravel Package Development

Create a folder as packages at root of laravel installation
Create your package folder. Eg. if your package name is HelloWorld then your folder name should be hello-world
Open the folder in command line and run vaah laravel make:package. It will start wizard and ask you the Vendor Name & Package Name.

Once your package is generated, you need add the path in composer.json file of laravel:

 ...
    "autoload-dev": {
        "classmap": [
            "tests/TestCase.php"
        ],
        "psr-4": {
            "YourVendorName\\YourPackageName\\": "packages-scr-path"
        }
    },
    ...

Register your package's service provider at config/app.php: YourVendorName\YourPackageName\YourPackageNameServiceProvider::class,.
Finally, run composer dump-autoload.

That's it, your package is ready for use in development environment.

You have access to following commands as well:

| Command | Alias | Details | | ------------- |:-------------:| -----:| | vaah laravel make:package | vaah lv:p | To general Laravel package | | vaah laravel make:package-reset | vaah lv:p-reset | To reset/delete generate files. | | vaah laravel make:package-file [type] [name] | vaah lv:p-file [type] [name] | To generate package file. |

List of commands:

vaah lv:p-file model fileName
vaah lv:p-file view fileName
vaah lv:p-file controller fileName
vaah lv:p-file seed fileName
vaah lv:p-file migration fileName

Support us

WebReinvent is a web agency based in Delhi, India. You'll find an overview of all our open source projects on github.

Setup Development Environment

Step 1:

Clone this repository

Step 2:

Run npm install

Step 4:

Now you can run vaah commands in development mode from terminal like:

bin\run [COMMAND]
bin\run DEBUG=* [COMMAND] //for command debbuging
bin\run lv:p
bin\run cms:install
bin\run cms:m
bin\run cms:crud // crud file for any section
bin\run cms:t
bin\run cms:auth

*Windows: If you want to debug the command then run following command first on:

set DEBUG=*

Step 5:

Run following command to publish the package to npm:

Change the version in package.json then run

npm publish

Step 6: Change log

To generate CHANGELOG.md, use following command:

auto-changelog

Change Log

Install npm install auto-changelog -g
To generate CHANGELOG.md, run auto-changelog in the root folder of the project

Maintain following pre-fixes to your commit messages:

Added:
Changed:
Deprecated:
Removed:
Fixed:
Security:

Usage

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.2.5 win32-x64 node-v20.15.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.2.2 win32-x64 node-v20.15.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.2.1 win32-x64 node-v20.15.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.2.0 win32-x64 node-v20.15.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.0.10 win32-x64 node-v20.15.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.0.8 win32-x64 node-v20.15.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.0.7 win32-x64 node-v20.11.1
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

$ npm install -g vaah
$ vaah COMMAND
running command...
$ vaah (--version)
vaah/3.0.6 darwin-arm64 node-v18.18.0
$ vaah --help [COMMAND]
USAGE
  $ vaah COMMAND
...

Commands

`vaah cms:auth`

Generate CRUD operations for VaahCMS

USAGE
  $ vaah cms:auth [--help]

FLAGS
  --help  Generate Auth operation for VaahCMS Themes

DESCRIPTION
  Generate CRUD operations for VaahCMS

See code: src/commands/cms/auth.ts

`vaah cms:crud`

Generate CRUD operations for VaahCMS

USAGE
  $ vaah cms:crud [--help]

FLAGS
  --help  Generate CRUD operation for VaahCMS

DESCRIPTION
  Generate CRUD operations for VaahCMS

See code: src/commands/cms/crud.ts

`vaah cms:install [PROJECT_NAME]`

Install VaahCMS

USAGE
  $ vaah cms:install [PROJECT_NAME] [--here] [-h]

ARGUMENTS
  PROJECT_NAME  [default: vaahcms] Enter the project folder name

FLAGS
  -h, --help  Show CLI help.
      --here  If you want to install VaahCMS in current directory

DESCRIPTION
  Install VaahCMS

See code: src/commands/cms/install.ts

`vaah cms:m`

To generate module for VaahCMS

USAGE
  $ vaah cms:m [-h] [-n] [-f]

FLAGS
  -f, --force
  -h, --help   Show CLI help.
  -n, --name   Show CLI help.

DESCRIPTION
  To generate module for VaahCMS

See code: src/commands/cms/m.ts

`vaah cms:m-make TYPE MODULE NAME`

Generate for VaahCMS Module

USAGE
  $ vaah cms:m-make TYPE MODULE NAME [-f] [-b] [-h] [-n]

FLAGS
  -b, --backend
  -f, --frontend
  -h, --help      Show CLI help.
  -n, --name      Show CLI help.

DESCRIPTION
  Generate for VaahCMS Module

See code: src/commands/cms/m-make.ts

`vaah cms:settings`

Vue3: Generate User CRUD for VaahCMS

USAGE
  $ vaah cms:settings [--help]

FLAGS
  --help  Vue3: Generate User CRUD for VaahCMS

DESCRIPTION
  Vue3: Generate User CRUD for VaahCMS

See code: src/commands/cms/settings.ts

`vaah cms:t`

To generate theme for VaahCMS

USAGE
  $ vaah cms:t [-h] [-n] [-f]

FLAGS
  -f, --force
  -h, --help   Show CLI help.
  -n, --name   Show CLI help.

DESCRIPTION
  To generate theme for VaahCMS

See code: src/commands/cms/t.ts

`vaah cms:t-make TYPE THEME NAME`

Generate for VaahCMS Theme

USAGE
  $ vaah cms:t-make TYPE THEME NAME [-f] [-b] [-h] [-n]

FLAGS
  -b, --backend
  -f, --frontend
  -h, --help      Show CLI help.
  -n, --name      Show CLI help.

DESCRIPTION
  Generate for VaahCMS Theme

See code: src/commands/cms/t-make.ts

`vaah cms:taxonomies`

Vue 3: Generate Taxonomies CRUD operations for VaahCMS

USAGE
  $ vaah cms:taxonomies [--help]

FLAGS
  --help  Vue 3: Generate Taxonomies CRUD operations for VaahCMS

DESCRIPTION
  Vue 3: Generate Taxonomies CRUD operations for VaahCMS

See code: src/commands/cms/taxonomies.ts

`vaah cms:users`

Vue3: Generate User CRUD for VaahCMS

USAGE
  $ vaah cms:users [--help]

FLAGS
  --help  Vue3: Generate User CRUD for VaahCMS

DESCRIPTION
  Vue3: Generate User CRUD for VaahCMS

See code: src/commands/cms/users.ts

`vaah flutter:install`

Installation of VaahFlutter

USAGE
  $ vaah flutter:install [--help]

FLAGS
  --help  Installation of VaahFlutter

DESCRIPTION
  Installation of VaahFlutter

See code: src/commands/flutter/install.ts

`vaah hello PERSON`

Say hello

USAGE
  $ vaah hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/hello/index.ts

`vaah hello:world`

Say hello world

USAGE
  $ vaah hello:world

DESCRIPTION
  Say hello world

EXAMPLES
  $ vaah hello:world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

`vaah help [COMMAND]`

Display help for vaah.

USAGE
  $ vaah help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for vaah.

See code: @oclif/plugin-help

`vaah plugins`

List installed plugins.

USAGE
  $ vaah plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ vaah plugins

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Vaah

Feature Roadmap

Completed

Planned

Install

VaahCms Installer

VaahFlutter Installer

VaahCms Module Generators

VaahCms Theme Generators

Laravel Generators

Laravel Package Development

You have access to following commands as well:

Support us

Setup Development Environment

Step 1:

Step 2:

Step 4:

Step 5:

Step 6: Change log

Change Log

Usage

Commands

vaah cms:auth

vaah cms:crud

vaah cms:install [PROJECT_NAME]

vaah cms:m

vaah cms:m-make TYPE MODULE NAME

vaah cms:settings

vaah cms:t

vaah cms:t-make TYPE THEME NAME

vaah cms:taxonomies

vaah cms:users

vaah flutter:install

vaah hello PERSON

vaah hello:world

vaah help [COMMAND]

vaah plugins

vaah plugins:install PLUGIN...

vaah plugins:inspect PLUGIN...

vaah plugins:install PLUGIN...

vaah plugins:link PLUGIN

vaah plugins:uninstall PLUGIN...

vaah plugins:reset

vaah plugins:uninstall PLUGIN...

vaah plugins:uninstall PLUGIN...

vaah plugins:update

vaah cms:auth

vaah cms:crud

vaah cms:install [PROJECT_NAME]

vaah cms:m

vaah cms:m-make TYPE MODULE NAME

vaah cms:settings

vaah cms:t

vaah cms:t-make TYPE THEME NAME

vaah cms:taxonomies

vaah cms:users

vaah flutter:install

vaah hello PERSON

vaah hello:world

vaah help [COMMAND]

vaah plugins

vaah plugins:install PLUGIN...

vaah plugins:inspect PLUGIN...

vaah plugins:install PLUGIN...

vaah plugins:link PLUGIN

vaah plugins:uninstall PLUGIN...

vaah plugins:reset

vaah plugins:uninstall PLUGIN...

vaah plugins:uninstall PLUGIN...

vaah plugins:update

vaah cms:auth

vaah cms:crud

vaah cms:install [PROJECT_NAME]

vaah cms:m

`vaah cms:auth`

`vaah cms:crud`

`vaah cms:install [PROJECT_NAME]`

`vaah cms:m`

`vaah cms:m-make TYPE MODULE NAME`

`vaah cms:settings`

`vaah cms:t`

`vaah cms:t-make TYPE THEME NAME`

`vaah cms:taxonomies`

`vaah cms:users`

`vaah flutter:install`

`vaah hello PERSON`

`vaah hello:world`

`vaah help [COMMAND]`

`vaah plugins`

`vaah plugins:install PLUGIN...`

`vaah plugins:inspect PLUGIN...`

`vaah plugins:install PLUGIN...`

`vaah plugins:link PLUGIN`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:reset`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:update`

`vaah cms:auth`

`vaah cms:crud`

`vaah cms:install [PROJECT_NAME]`

`vaah cms:m`

`vaah cms:m-make TYPE MODULE NAME`

`vaah cms:settings`

`vaah cms:t`

`vaah cms:t-make TYPE THEME NAME`

`vaah cms:taxonomies`

`vaah cms:users`

`vaah flutter:install`

`vaah hello PERSON`

`vaah hello:world`

`vaah help [COMMAND]`

`vaah plugins`

`vaah plugins:install PLUGIN...`

`vaah plugins:inspect PLUGIN...`

`vaah plugins:install PLUGIN...`

`vaah plugins:link PLUGIN`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:reset`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:update`

`vaah cms:auth`

`vaah cms:crud`

`vaah cms:install [PROJECT_NAME]`

`vaah cms:m`

`vaah cms:m-make TYPE MODULE NAME`

`vaah cms:settings`

`vaah cms:t`

`vaah cms:t-make TYPE THEME NAME`

`vaah cms:taxonomies`

`vaah cms:users`

`vaah flutter:install`

`vaah hello PERSON`

`vaah hello:world`

`vaah help [COMMAND]`

`vaah plugins`

`vaah plugins:install PLUGIN...`

`vaah plugins:inspect PLUGIN...`

`vaah plugins:install PLUGIN...`

`vaah plugins:link PLUGIN`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:reset`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:uninstall PLUGIN...`

`vaah plugins:update`

`vaah cms:auth`

`vaah cms:crud`

`vaah cms:install [PROJECT_NAME]`

`vaah cms:m`

`vaah cms:m-make TYPE MODULE NAME`

`vaah cms:settings`

`vaah cms:t`

`vaah cms:t-make TYPE THEME NAME`