apeman

Meta application framework.

apeman

Meta application framework.

Installation


apeman is available as an npm package.

$ npm install apeman -g

Quick Start


Run apeman init command in your project root.

# Initialize a current directory as an apemanfile.
$ apeman init

This generates a file named Apemanfile.js , which contains configurations for an apeman project.

Then you can use various apeman commands at the directory.

Mastering apeman Commands


### `apeman app` Command

This command is a synonym of apeman-app.

$ apeman app -h
 
 
  Usage: app|application [options] [name]
 
  Run an apeman app.
 
  Options:
 
    -h, --help                           output usage information
    -v, --verbose                        Show verbose logs
    -p, --port <port>                    Number of port
    -s, --setup <setup>                  Server setup module.
    -o, --log <log>                      Log file path.
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-app

### `apeman crt` Command

This command is a synonym of apeman-crt.

$ apeman crt -h
 
 
  Usage: crt|certificate [options] <name>
 
  Options:
 
    -h, --help                           output usage information
    -c, --configuration <configuration>  Pathname of Apemanfile
    -o, --out <out>                      Output directory path
    -s, --self                           Self signed or not.
    -f, --force                          Force to write.
    -d, --days                           Days for the certification.
 
 

For mor information, see README of apeman-crt

### `apeman d` Command

This command is a synonym of apeman-d.

$ apeman d -h
 
 
  Usage: d|daemon [options] <action> <script>
 
  Options:
 
    -h, --help                           output usage information
    -v, --verbose                        Show verbose logs
    -f, --force                          Force to action
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-d

### `apeman doc` Command

This command is a synonym of apeman-doc.

$ apeman doc -h
 
 
  Usage: doc|document [options]
 
  Generate project documentation.
 
  Options:
 
    -h, --help                           output usage information
    -o, --out <out>                      Output directory path.
    -c, --configuration <configuration>  Pathname of Apemanfile
    -C, --context <context>              Pathname of mock context file.
 
 

For mor information, see README of apeman-doc

### `apeman dply` Command

This command is a synonym of apeman-dply.

$ apeman dply -h
 
 
  Usage: dply|deploy [options] [name...]
 
  Deploy project on docker.
 
  Options:
 
    -h, --help                           output usage information
    -v, --verbose                        Show verbose logs
    -f, --force                          Force to remove container.
    -d, --delete                         Remove container.
    -c, --configuration <configuration>  Pathname of Apemanfile
    -l, --list                           List available watches
    -t, --tty                            Open terminal for dply
    -r, --rerun                          Delete and execute deploying again.
    -e, --exec <exec>                    Execute a command inside container.
    -p, --print                          Print container log.
    -P, --printon                        Print and follow container log.
 
 

For mor information, see README of apeman-dply

### `apeman infr` Command

This command is a synonym of apeman-infr.

$ apeman infr -h
 
 
  Usage: infr|infra [options] [name...]
 
  Setup infra.
 
  Options:
 
    -h, --help                           output usage information
    -v, --verbose                        Show verbose logs
    -f, --force                          Force to remove image.
    -r, --rebuild                        Delete and build infra again.
    -d, --delete                         Remove image.
    -c, --configuration <configuration>  Pathname of Apemanfile
    -l, --list                           List available watches
 
 

For mor information, see README of apeman-infr

### `apeman init` Command

This command is a synonym of apeman-init.

$ apeman init -h
 
 
  Usage: init|initialize [options]
 
  Initialize a directory as an apeman project.
 
  Options:
 
    -h, --help               output usage information
    -f, --force              Force to init.
    -d, --dirname <dirname>  Directory name to init.
    -s, --silent             Disable console logs
    -p, --pkg <pkg>          Path of package.json
 
 

For mor information, see README of apeman-init

### `apeman keep` Command

This command is a synonym of apeman-keep.

$ apeman keep -h
 
 
  Usage: keep|keeps [options]
 
  Keep process running.
 
  Options:
 
    -h, --help  output usage information
 
 

For mor information, see README of apeman-keep

### `apeman need` Command

This command is a synonym of apeman-need.

$ apeman need -h
 
 
  Usage: need|needs [options]
 
  Check project needs.
 
  Options:
 
    -h, --help                           output usage information
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-need

### `apeman prxy` Command

This command is a synonym of apeman-prxy.

$ apeman prxy -h
 
 
  Usage: prxy|proxy [options]
 
  Reverse proxy manager
 
  Options:
 
    -h, --help           output usage information
    -d, --delete         Remove container.
    -r, --rerun          Delete and execute deploying again.
    -p, --print          Print container log.
    -P, --printon        Print and follow container log.
    -t, --http <http>    Port for http
    -T, --https <https>  Port for https
 
 

For mor information, see README of apeman-prxy

### `apeman scff` Command

This command is a synonym of apeman-scff.

$ apeman scff -h
 
 
  Usage: scff|scaffold [options] [type] [dest]
 
  Generate project scaffold.
 
  Options:
 
    -h, --help      output usage information
    -t, --straight  Scaffold without asking.
    -s, --silent    Disable console logs
    -f, --force     Force to generate scaffold
 
 

For mor information, see README of apeman-scff

### `apeman scrt` Command

This command is a synonym of apeman-scrt.

$ apeman scrt -h
 
 
  Usage: scrt|secret [options] [name...]
 
  Encrypt/decrypt secret file.
 
  Options:
 
    -h, --help                           output usage information
    -p, --password <password>            Password of secret.
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-scrt

### `apeman show` Command

This command is a synonym of apeman-show.

$ apeman show -h
 
 
  Usage: show|shows [options] [keypath...]
 
  Show apemanfile configuration.
 
  Options:
 
    -h, --help                           output usage information
    -c, --configuration <configuration>  Pathname of Apemanfile
    -k, --keysonly                       Show keys only
 
 

For mor information, see README of apeman-show

### `apeman srch` Command

This command is a synonym of apeman-srch.

$ apeman srch -h
 
 
  Usage: srch|search [options] [term...]
 
  Search apeman modules.
 
  Options:
 
    -h, --help         output usage information
    -v, --verbose      Show verbose logs
    -t, --type <type>  Type to search.
 
 

For mor information, see README of apeman-srch

### `apeman task` Command

This command is a synonym of apeman-task.

$ apeman task -h
 
 
  Usage: task|tasks [options] [name...]
 
  Run tasks.
 
  Options:
 
    -h, --help                           output usage information
    -s, --silent                         Disable console logs
    -v, --verbose                        Show verbose logs
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-task

### `apeman tmpl` Command

This command is a synonym of apeman-tmpl.

$ apeman tmpl -h
 
 
  Usage: tmpl|template [options] [name...]
 
  Render template files.
 
  Options:
 
    -h, --help                           output usage information
    -v, --verbose                        Show verbose logs
    -l, --list                           List available templates
    -f, --force                          Force to render template even if already exists
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-tmpl

### `apeman tree` Command

This command is a synonym of apeman-tree.

$ apeman tree -h
 
 
  Usage: tree|trees [options]
 
  Show project inheritance in the tree.
 
  Options:
 
    -h, --help                           output usage information
    -c, --configuration <configuration>  Pathname of Apemanfile
 
 

For mor information, see README of apeman-tree

### `apeman upg` Command

This command is a synonym of apeman-upg.

$ apeman upg -h
 
 
  Usage: upg|upgrade [options]
 
  Update apeman global module.
 
  Options:
 
    -h, --help     output usage information
    -v, --verbose  Show verbose logs
 
 

For mor information, see README of apeman-upg

### `apeman wtch` Command

This command is a synonym of apeman-wtch.

$ apeman wtch -h
 
 
  Usage: wtch|watch [options] [name...]
 
  Watch files to trigger action.
 
  Options:
 
    -h, --help                           output usage information
    -v, --verbose                        Show verbose logs
    -c, --configuration <configuration>  Pathname of Apemanfile
    -t, --interval <interval>            Milliseconds of interval to run action.
    -l, --list                           List available watches
 
 

For mor information, see README of apeman-wtch

This software is released under the MIT License.