axel-cli
    TypeScript icon, indicating that this package has built-in type declarations

    0.6.3 • Public • Published

    @axel/cli

    oclif Version Downloads/week License

    Usage

    $ npm install -g axel-cli
    $ axel COMMAND
    running command...
    $ axel (-v|--version|version)
    axel-cli/0.6.3 darwin-x64 node-v14.19.1
    $ axel --help [COMMAND]
    USAGE
      $ axel COMMAND
    ...

    Commands

    axel db:import

    Generate sequelize models and json schemas from database

    Generate sequelize models and json schemas from database
    
    USAGE
      $ axel db:import
    
    OPTIONS
      -f, --force          Overwrite models if present before recreating them (Do not use in production...)
      -h, --help           show CLI help
      -s, --schemas        Also generate schemas
      -t, --tables=tables  list of tables to import
    

    See code: src/commands/db/import.ts

    axel db:sync

    Sync sequelize models to the database

    Sync sequelize models to the database
    
    USAGE
      $ axel db:sync
    
    OPTIONS
      -a, --alter   Alter table columns if they already exist.
      -f, --force   Drop tables before recreating them (Do not use in production...
      -h, --help    show CLI help
      -s, --silent  Do not ask for confirmation
    

    See code: src/commands/db/sync.ts

    axel generate TARGET

    Generate various documents for your axel project

    Generate various documents for your axel project
    
    USAGE
      $ axel generate TARGET
    
    OPTIONS
      -f, --force
      -h, --help   show CLI help
      -t, --type=  [default: sql] type of project
    

    See code: src/commands/generate.ts

    axel generate:api NAME

    Generate an api for your axel project

    Generate an api for your axel project
    
    USAGE
      $ axel generate:api NAME
    
    OPTIONS
      -h, --help            show CLI help
      -i, --interactive
      -t, --type=sql|mongo  [default: sql] type of database
      --fields=fields       List of fields to declare in the model
      --force               Whether to generate schema model also when generating an sql model
      --with-schema         Whether to generate schema model also when generating an sql model
    

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

    axel generate:controller NAME

    Generate a controller for your axel project

    Generate a controller for your axel project
    
    USAGE
      $ axel generate:controller NAME
    
    OPTIONS
      -f, --force
      -h, --help                 show CLI help
      -t, --type=sql|mongo|bare  (required) type of project
    

    See code: src/commands/generate/controller.ts

    axel generate:hook NAME

    Generate an api hook for your axel project

    Generate an api hook for your axel project
    
    USAGE
      $ axel generate:hook NAME
    
    OPTIONS
      -f, --force
      -h, --help   show CLI help
    

    See code: src/commands/generate/hook.ts

    axel generate:model NAME

    Generate a model for your axel project

    Generate a model for your axel project
    
    USAGE
      $ axel generate:model NAME
    
    OPTIONS
      -f, --force
      -h, --help                  show CLI help
      -i, --interactive
      -t, --types=sql|schema|all  (required) type of project
      --fields=fields             List of fields to declare
      --from-sequelize            Generate the schema from the sequelize model
    

    See code: src/commands/generate/model.ts

    axel generate:route NAME

    Generate an api for your axel project

    Generate an api for your axel project
    
    USAGE
      $ axel generate:route NAME
    
    OPTIONS
      -h, --help           show CLI help
      -s, --secure=secure  Add secure policies to the app
    

    See code: src/commands/generate/route.ts

    axel generate:test NAME

    Generate an api test for your axel project

    Generate an api test for your axel project
    
    USAGE
      $ axel generate:test NAME
    
    OPTIONS
      -f, --force
      -h, --help            show CLI help
      -t, --type=bare|full  (required) type of test
    

    See code: src/commands/generate/test.ts

    axel hello [FILE]

    describe the command here

    describe the command here
    
    USAGE
      $ axel hello [FILE]
    
    OPTIONS
      -f, --force
      -h, --help       show CLI help
      -n, --name=name  name to print
    
    EXAMPLE
      $ axel hello
      hello world from ./src/hello.ts!
    

    See code: src/commands/hello.ts

    axel help [COMMAND]

    display help for axel

    display help for <%= config.bin %>
    
    USAGE
      $ axel help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    axel init [NAME]

    describe the command here

    describe the command here
    
    USAGE
      $ axel init [NAME]
    
    OPTIONS
      -h, --help  show CLI help
    

    See code: src/commands/init.ts

    axel new [NAME]

    Create a new axel project.

    Create a new axel project.
      - Download the zip of project
      - Unzip it,
      - install peer dependencies,
      - Place relevant crud controller, auth controller, and Authservices according to the database system.
      
    
    USAGE
      $ axel new [NAME]
    
    OPTIONS
      -h, --help              show CLI help
      -n, --type=mongodb|sql  name to print
      -s, --silent            Silent
    
    DESCRIPTION
      - Download the zip of project
         - Unzip it,
         - install peer dependencies,
         - Place relevant crud controller, auth controller, and Authservices according to the database system.
    

    See code: src/commands/new.ts

    axel run [FILE]

    describe the command here

    describe the command here
    
    USAGE
      $ axel run [FILE]
    
    OPTIONS
      -f, --force
      -h, --help       show CLI help
      -n, --name=name  name to print
    

    See code: src/commands/run.ts

    Features / Todo

    Keywords

    Install

    npm i axel-cli

    DownloadsWeekly Downloads

    70

    Version

    0.6.3

    License

    MIT

    Unpacked Size

    140 kB

    Total Files

    61

    Last publish

    Collaborators

    • enyosolutions