@portex-app/cli

Portex CLI is a command line tool for creating and managing appliaction on multiple platforms.

• @portex-app/cli
• Usage
• Commands

Usage

$ npm install -g @portex-app/cli
$ portex COMMAND
running command...
$ portex (--version)
@portex-app/cli/0.1.4 darwin-arm64 node-v22.2.0
$ portex --help [COMMAND]
USAGE
  $ portex COMMAND
...

Commands

• portex bot info APPNAME
• portex bot menu set APPNAME MENUNAME MENUURL
• portex bot message APPNAME [PATH]
• portex bot register APPNAME BOTTOKEN
• portex deploy APPNAME PATH [DESCRIPTION]
• portex help [COMMAND]
• portex login
• portex ls
• portex new
• portex publish APPNAME VERSION

portex bot info APPNAME

Manage bots in the mini-app

USAGE
  $ portex bot info APPNAME

ARGUMENTS
  APPNAME  application name

See code: src/commands/bot/info.ts

portex bot menu set APPNAME MENUNAME MENUURL

About Telegram Bot Command

USAGE
  $ portex bot menu set APPNAME MENUNAME MENUURL

ARGUMENTS
  APPNAME   appliaction name
  MENUNAME  [default: open] menu name
  MENUURL   menu url

DESCRIPTION
  About Telegram Bot Command

  set Telegram Menu button

See code: src/commands/bot/menu/set.ts

portex bot message APPNAME [PATH]

Get or save bot messages

USAGE
  $ portex bot message APPNAME [PATH] [-i | -o | -t]

ARGUMENTS
  APPNAME  application name
  PATH     file path or directory path

FLAGS
  -i, --input     input messages from file
  -o, --output    output messages to file
  -t, --template  output template instead of actual data

DESCRIPTION
  Get or save bot messages

  get or save bot messages

See code: src/commands/bot/message.ts

portex bot register APPNAME BOTTOKEN

About Telegram Bot Command

USAGE
  $ portex bot register APPNAME BOTTOKEN

ARGUMENTS
  APPNAME   deploy appliaction name
  BOTTOKEN  telegram bot token

DESCRIPTION
  About Telegram Bot Command

  register telegram bot

See code: src/commands/bot/register.ts

portex deploy APPNAME PATH [DESCRIPTION]

Deploy mini-app

USAGE
  $ portex deploy APPNAME PATH [DESCRIPTION]

ARGUMENTS
  APPNAME      deploy appliaction name
  PATH         deploy appliaction path
  DESCRIPTION  deploy appliaction description

DESCRIPTION
  Deploy mini-app

  deploy mini-app, upload mini-app package from application build path.

See code: src/commands/deploy.ts

portex help [COMMAND]

Display help for portex.

USAGE
  $ portex 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 portex.

See code: @oclif/plugin-help

portex login

Login to Portex CLI

USAGE
  $ portex login

DESCRIPTION
  Login to Portex CLI

  login to your portex account

See code: src/commands/login.ts

portex ls

get application list

USAGE
  $ portex ls [-h]

FLAGS
  -h, --help  Displays this help information.

See code: src/commands/ls.ts

portex new

Create a new mini-app

USAGE
  $ portex new

See code: src/commands/new.ts

portex publish APPNAME VERSION

Publish mini-app

USAGE
  $ portex publish APPNAME VERSION [-e dev|test|prod]

ARGUMENTS
  APPNAME  publish application name
  VERSION  publish application version

FLAGS
  -e, --env=<option>  [default: dev] publish environment
                      <options: dev|test|prod>

DESCRIPTION
  Publish mini-app

  publish mini-app to portex

See code: src/commands/publish.ts