@hypi/cli
v0.8.0
Published
Application developer community centred around Hypi's low-code, serverless development platform.
Downloads
15
Keywords
Readme
hypi
hypi command line interface
Install
$ npm install -g @hypi/cli
Getting started [ReactJS Project]
https://github.com/hypi-universe/hypi-cli-react-example
Getting started [Angular Project]
https://github.com/hypi-universe/hypi-cli-angular-example
Getting started [Flutter Project]
https://github.com/hypi-universe/hypi-cli-flutter-example
Usage
$ npm install -g @hypi/cli
$ hypi COMMAND
running command...
$ hypi (-v|--version|version)
@hypi/cli/0.8.0 darwin-arm64 node-v16.18.1
$ hypi --help [COMMAND]
USAGE
$ hypi COMMAND
...
Commands
hypi commands
hypi fn ACTION [NAME] [VALUE]
hypi generate [PLATFORM]
hypi get
hypi help [COMMAND]
hypi init
hypi load
hypi login
hypi sync
hypi update [CHANNEL]
hypi wsk
hypi commands
list all the commands
USAGE
$ hypi commands
OPTIONS
-h, --help show CLI help
-j, --json display unfiltered api data in json format
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
See code: @oclif/plugin-commands
hypi fn ACTION [NAME] [VALUE]
Manage Hypi serverless functions
USAGE
$ hypi fn ACTION [NAME] [VALUE]
ARGUMENTS
ACTION (push|list|invoke|deploy-version) [default: list] The specific action to perform on the function
NAME The function's name
VALUE For push, this is the file containing the function's code e.g. func.js or func.zip for functions with
dependencies
OPTIONS
-f, --file=file Used with invoke to specify the specific file to execute
-h, --help show CLI help
-l, --make_live Used with fn push or fn deploy to make the given version the one that is live (used to serve
requests)
-m, --method=method Used with invoke to specify the specific function to execute from the file
-v, --version=version Used with invoke to specify the specific version of the function to execute
EXAMPLES
$ hypi fn list
$ hypi fn list -v 4
$ hypi fn list -v all
$ hypi fn push hello hello.js
$ hypi fn push hello hello.js --make_live false
$ hypi fn push hello fn-with-dependencies.zip
$ hypi fn deploy-version hello 4
$ hypi fn invoke hello
$ hypi fn invoke hello --file index.js --arg message:'Test 1' --arg b:2 --env c:'hello there'
$ hypi fn invoke hello --file index.js --method myFuncName --arg message:'Test 1' --arg b:2 --env c:'hello there'
See code: src/commands/fn.ts
hypi generate [PLATFORM]
generate the schema typescript file
USAGE
$ hypi generate [PLATFORM]
OPTIONS
-h, --help show CLI help
-p, --platform=flutter|reactjs|angular|vuejs
EXAMPLES
$ hypi generate angular
$ hypi generate -p=angular
$ hypi generate --platform=angular
See code: src/commands/generate.ts
hypi get
Get configuration
USAGE
$ hypi get
OPTIONS
-a, --api_domain show configured api domain
-d, --domain show configured domain
-e, --token_expires show token expiry
-f, --fn_domain show configured fn domain
-h, --help show CLI help
-t, --token show token
-u, --auth show authentication
EXAMPLES
$ hypi get
$ hypi get -a
$ hypi get --api_domain
$ hypi get -a -f
$ hypi get --api_domain --fn_domain
See code: src/commands/get.ts
hypi help [COMMAND]
display help for hypi
USAGE
$ hypi help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
hypi init
Init a hypi app
USAGE
$ hypi init
OPTIONS
-h, --help show CLI help
-i, --have_instance
EXAMPLES
$ hypi init -i
$ hypi init --have_instance
$ hypi init
See code: src/commands/init.ts
hypi load
Load data from file and Upsert to hypi Graphql Type
USAGE
$ hypi load
OPTIONS
-f, --file=file
-h, --help show CLI help
-k, --kind=line_delimited|array|csv
-m, --mapping=mapping
-t, --glType=glType
EXAMPLES
$ hypi load -f file.json -k line_delimited -t MyType
$ hypi load -f file.json -k line_delimited -m mapping.json -t MyType
$ hypi load -f array.json.gz -k array -m mapping.json -t Test
See code: src/commands/load.ts
hypi login
Login to hypi with email and password or domain and token
USAGE
$ hypi login
OPTIONS
-d, --domain
-h, --help show CLI help
EXAMPLES
$ hypi login
$ hypi login -d
$ hypi login --domain
See code: src/commands/login.ts
hypi sync
sync user local schema with hypi
USAGE
$ hypi sync
OPTIONS
-h, --help show CLI help
EXAMPLE
$ hypi sync
See code: src/commands/sync.ts
hypi update [CHANNEL]
update the hypi CLI
USAGE
$ hypi update [CHANNEL]
OPTIONS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=version Install a specific version.
--force Force a re-download of the requested version.
EXAMPLES
[object Object]
[object Object]
[object Object]
[object Object]
See code: @oclif/plugin-update
hypi wsk
Invoke the OpenWhisk command to perform serverless functions
USAGE
$ hypi wsk
OPTIONS
-h, --help show CLI help
EXAMPLES
$ hypi wsk configure
$ hypi wsk action list
$ hypi wsk action create hello hello.js
$ hypi wsk action invoke hello --result
See code: src/commands/wsk.ts
hypi help [COMMAND]
display help for hypi
USAGE
$ hypi help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
hypi update [CHANNEL]
update the hypi CLI
USAGE
$ hypi update [CHANNEL]
OPTIONS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=version Install a specific version.
--force Force a re-download of the requested version.
EXAMPLES
[object Object]
[object Object]
[object Object]
[object Object]
See code: @oclif/plugin-update
Build instructions
For Buiilding you will need to install olcif-dev https://github.com/oclif/dev-cli
npm install -g @oclif/dev-cli
npm
- sudo npm adduser --scope=hypi --always-auth
- npm version
- sudo npm publish --access public
Standalone tarballs
- sudo oclif-dev pack
- user does not have to already have node installed to use the CLI
- To publish, you can copy the files from
./dist
or useoclif-dev publish
to copy the files to S3
Windows installer
Make sure you have 7z && nsis installed https://www.journaldev.com/29456/install-7zip-ubuntu https://www.howtoinstall.me/ubuntu/18-04/nsis/
- sudo oclif-dev pack:win
- It will build into
./dist/win
- Publish to S3 with
oclif-dev publish:win
macOS installer
- oclif-dev pack:macos
- It will build into
./dist/macos
- Publish to S3 with
oclif-dev publish:macos
- You need to set the macOS identifier at oclif.macos.identifier in package.json
- To sign the installer, set oclif.macos.sign in package.json to a certificate (For the Heroku CLI this is "Developer ID Installer: Heroku INC"). And optionally set the keychain with OSX_KEYCHAIN. https://developer.apple.com/developer-id/
Ubuntu/Debian packages
- Set the MYCLI_DEB_KEY to a gpg key id to create the gpg files
export MYCLI_DEB_KEY=MY_DEB_KEY
- oclif-dev pack:deb
- Published to S3 with oclif-dev publish:deb. Once it's published to S3, users can install with the following:
$ wget -qO- https://mys3bucket.s3.amazonaws.com/apt/release.key | apt-key add - # you will need to upload this file manually
$ sudo echo "deb https://mys3bucket.s3.amazonaws.com/apt ./" > /etc/apt/sources.list.d/mycli.list
$ sudo apt update
$ sudo apt install -y mycli
Autoupdater
- Tarballs as well as the installers can be made autoupdatable by adding the @oclif/plugin-update plugin.
- CLI will autoupdate in the background or when mycli update is run.
- If you don't want to use S3, you can still run oclif-dev pack and it will build tarballs. To get the updater to work, set oclif.update.s3.host in package.json to a host that has the files built in ./dist from oclif-dev pack. This host does not need to be an S3 host. To customize the URL paths, see the S3 templates in @oclif/config. Snapcraft