Skip to content

Home

Jump to bottom
Drew Nutter edited this page Oct 12, 2016 · 1 revision

This article combines the help information accessible within the interface into a single tidy document for easy reference.

> help

Documented commands (type help <topic>):
========================================
exit  help  log  login  logout  match  print  py  search  shell

Table of Contents

Exit

> help exit
usage: exit

Exits the shell without logging out.

Help

> help help
List available commands with "help" or detailed help with "help cmd".

View Logs

> help log
usage: log [-h] [-f FIND] [-s] [-i] [-m] [-a | -l LINES]

Print application log.

optional arguments:
  -h, --help            show this help message and exit
  -f FIND, --find FIND  Print only lines containing search string.
  -a, --all             Do not limit log output length.
  -l LINES, --lines LINES
                        Specify output length. Default is 100 lines.

Output Type:
  Using any of these options will limit output to explicitly declared log
  types.

  -s, --service         Explicitly declare service logs.
  -i, --interactive     Explicitly declare interactive logs.
  -m, --matches         Explicitly declare match logs.

Login

> help login
usage: login [username]

Logs into an account.

Logout

> help logout
usage: logout

Ends the user session without exiting the shell.

Work with Matches

> help match
usage: match [-h] {find,view,update} ...

Finds openings that match listings.

positional arguments:
  {find,view,update}  Use one of these subcommands.
    find              Find new matches.
    view              View matches.
    update            Update matches by removed filled openings.

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

Find Matches

> match find -h
usage: match find [-h] [-s SEARCH] [-p PAGES] [-i INITIAL_PAGE] [-r]

optional arguments:
  -h, --help            show this help message and exit
  -s SEARCH, --search SEARCH
                        Specify a search term.
  -p PAGES, --pages PAGES
                        Number of pages.
  -i INITIAL_PAGE, --initial_page INITIAL_PAGE
                        Page to start from.
  -r, --random          Use random pages.

View Matches

> match view -h
usage: match view [-h] [-a] [-r] [-s]

optional arguments:
  -h, --help        show this help message and exit
  -a, --all         View all matches instead of only best matches.
  -r, --review      Review and edit matches.
  -s, --skip-check  Skip the opening fill check.

Update Fill Status

> match update -h
usage: match update [-h]

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

Print Text

> help print
usage: print [text]

Simple text printer.

Run Python Code

> help py
usage: py [python code]

Execute arbitrary python code with access to this program's classes and session state in a non-persistent environment.

Search

> help search
usage: search [-h] [-r opening | -t listing] [-p PAGES] [-i INITIAL_PAGE]

Finds openings or listings.

optional arguments:
  -h, --help            show this help message and exit
  -r OPENING, --opening OPENING
                        Search openings. Specify a search term.
  -t LISTING, --listing LISTING
                        Search listings. Specify a search term.
  -p PAGES, --pages PAGES
                        Number of pages.
  -i INITIAL_PAGE, --initial_page INITIAL_PAGE
                        Page to start from.

Shell Commands

> help shell
usage: shell [shell command] OR ![shell command]

Executes shell command in a non-persistent environment.
Clone this wiki locally