orxray

orxray is the command line tool for xray. It can be used to quickly perform various xray analysis tasks. The orxray tool consists of many subcommands.

Introduction

orxray is the command line tool for xray. It can be used to quickly perform various xray analysis tasks.

Usage

Use --help to get help information

The orxray tool consists of many subcommands. You can run “orxray –help” to print these subcommands.

$ orxray --help
Usage: orxray COMMAND [OPTIONS]

COMMAND:
    agent
    app
    analyzer
    autorun
    batch
    job
    process
    report
    ysql
    ylua
    ylang
    new-ysql
    new-ylua
    new-ylang
    ylang-header
    auto-analyze

GLOBAL OPTIONS:
    --help
    --config                           Specify the config file, default is ~/.orxray/config.

Each subcommand has a set of functions. You can print help in subcommand context.

$ orxray agent --help
Usage: orxray agent ACTION [OPTIONS]

ACTIONS:
    list
    get-default

GLOBAL OPTIONS:
    --help
    --config                           specify config file, default is ~/.orxray/config.

You can further access the usage of the ACTION subcommand

$ orxray agent list --help
Usage: orxray agent list [OPTIONS]

OPTIONS:
    -s, --page-size integer            page size, 20(default).

GLOBAL OPTIONS:
    --help
    --config                           specify config file, default is ~/.orxray/config.

Specify the config file

The default config file is ~/.oredge/config. orxray reads the default configuration items from this file, for example default-agent, console host …

You can use --config to specify the config file other than ~/.oredge/config

$ orxray agent list --config=/path/to/config
ID      HOSTNAME                        IP              SYSTEM          VERSION
1       centos7                         135.17.228.191  centos-7        816
4       amzn2-xray-agent                133.17.228.191  amazon-2        816
5       suse15-aaa                      133.17.229.132  opensuse-15     802
7       ubuntu18-xray-agent             133.17.228.191  ubuntu-bionic   816
9       deploy-server                   13.162.120.58   centos-7        796
10      centos7                         133.17.231.163  centos-7        797