Skip to content

Latest commit

 

History

History
375 lines (269 loc) · 8.94 KB

cli_help.md

File metadata and controls

375 lines (269 loc) · 8.94 KB

py-ulord-api cli reference

created on 2018-05-16

Table of Contents

ulordapi

usage: ulordapi [options|sub-command] [-h]

ulordapi ---- SDK for the Ulord APIs

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit

ulordapi sub-command:
  ulordapi sub-command,reading API documents

  {daemon,UP,udfs,DB,config}
                        using basic config - E:\ulord\ulord-blog-demo\venv\lib
                        \site-
                        packages\ulordapi-0.0.1-py2.7.egg\ulordapi\config
    daemon              Daemon process,including web server and udfs daemon.
    UP                  main functions
    udfs                transfer resources to the platform
    DB                  Manage database
    config              Manage configuration

Use 'ulordapi <command> --help' to learn more about each command.

EXIT STATUS

The CLI will exit with one of the following values:

0   Successful execution.
1   Failed executions.

ulordapi -v

This will show the version of the ulordapi

ulordapi 0.0.1

ulordapi daemon

Start a daemon for download, upload and webserver.It will start in the program when it was needed.

usage: ulordapi daemon [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP

usage: ulordapi UP <actions> [<value>] [-h]  ...

optional arguments:
  -h, --help           show this help message and exit

UP COMMANDS:
  packing ulord-platform HTTP APIs and some transmission functions

                       just for the Senior programmer functions.
    create             create wallet
    publish            publish data to the ulord
    transaction        transaction on the ulord
    paytouser          activity send ulord to the user
    resourceslist      list all resources
    querybalance       query user's balance
    checkisbought      check the resource if bought
    queryuserpublished
                       query user's published
    queryuserbought    query user's bought
    queryincomebillings
                       query user's income billings
    queryoutgobillings
                       query user's outgo billings
    querybillingsdetail
                       query the detail of user's billings
    querybillings      query user's billings
    querypublishnum    query the num of user's published

ulordapi UP create

Create wallet for the user.

usage: ulordapi UP <actions> [<value>] create [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP publish

Publish data to the ulord-platform.

usage: ulordapi UP <actions> [<value>] publish [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP transaction

Make a transaction in the ulord accroding to the ulord-platform.

usage: ulordapi UP <actions> [<value>] transaction [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP paytouser

Pay develop's amount to the user.This is a web activity.You can edit the config to change the amount.(Default amount=10)

usage: ulordapi UP <actions> [<value>] paytouser [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP resourceslist

List all the resources in the app from the ulord-platform.

usage: ulordapi UP <actions> [<value>] resourceslist [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP querybalance

Query the user's balance.

usage: ulordapi UP <actions> [<value>] querybalance [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP checkisbought

Check the resource if bought or not.

usage: ulordapi UP <actions> [<value>] checkisbought [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP queryuserpublished

Query the resources list which the user has published.

usage: ulordapi UP <actions> [<value>] queryuserpublished [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP queryuserbought

Query the resources list which the user has bought.

usage: ulordapi UP <actions> [<value>] queryuserbought [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP queryincomebillings

Query the user's income list.

usage: ulordapi UP <actions> [<value>] queryincomebillings [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP queryoutgobillings

Query the user's outgo list.

usage: ulordapi UP <actions> [<value>] queryoutgobillings [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP querybillingsdetail

Query the user billings detail list.

usage: ulordapi UP <actions> [<value>] querybillingsdetail [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP querybillings

Query the user billings detail list.

usage: ulordapi UP <actions> [<value>] querybillings [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi UP querypublishnum

Query the num of the user published resources.

usage: ulordapi UP <actions> [<value>] querypublishnum [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi udfs

usage: ulordapi udfs [upload <file>] | [download|cat <udfs-hash>] [-h]  ...

optional arguments:
  -h, --help  show this help message and exit

UDFS COMMANDS:
  udfs is a high speed transmitter base on the ulord-platform

              upload resources,download/cat resources from the ulord-platform
    upload    upload resources to udfs
    download  download resources from udfs
    cat       look up resources from udfs

ulordapi udfs upload

usage: ulordapi udfs [upload <file>] | [download|cat <udfs-hash>] upload [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi udfs download

usage: ulordapi udfs [upload <file>] | [download|cat <udfs-hash>] download
       [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi udfs cat

usage: ulordapi udfs [upload <file>] | [download|cat <udfs-hash>] cat [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi DB

usage: ulordapi DB <actions> [-h]  ...

optional arguments:
  -h, --help  show this help message and exit

DB COMMANDS:
  create simple database and some simple APIs

              Manage database
    create    create database

ulordapi DB create

usage: ulordapi DB <actions> create [-h]

optional arguments:
  -h, --help  show this help message and exit

ulordapi config

usage: ulordapi config <key> [<value>] [-h]  ...

optional arguments:
  -h, --help  show this help message and exit

config commands:
  Config Management.It controls configuration variables. The configuration
  values are stored in a config file inside your ulord repository(E:\ulord
  \ulord-blog-demo\venv\lib\site-
  packages\ulordapi-0.0.1-py2.7.egg\ulordapi\config).

              Get and set ulordapi config values.
    show      show config.Output config file contents.
    edit      edit config

ulordapi config show

usage: config show [-h] [[key] [[key] ...]]

positional arguments:
  [key]       show config.Output config file contents.

optional arguments:
  -h, --help  show this help message and exit

ulordapi config edit

usage: config edit [-h] [[key] [[key] ...]]

positional arguments:
  [key]       edit config.Open the config file for editing.

optional arguments:
  -h, --help  show this help message and exit