Command Line

Minitrade provides a command line interface to manage the lifecycles of background services, include:

• Scheduler
• IB gateway
• Web UI

minitrade

Usage:

minitrade [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

backtest

Run backtest for particular plan

Usage:

minitrade backtest [OPTIONS] PLAN_ID_OR_NAME

Options:

Name	Type	Description	Default
--run_id	text	Specify an unique run ID manually	None
--dryrun	boolean	Dry run only, don't place orders	False
--pytest	boolean	Run in test mode	False
--help	boolean	Show this message and exit.	False

ib

Manage the execution of IB gateway

Usage:

minitrade ib [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

diagnose

Diagnose IB login issues

Usage:

minitrade ib diagnose [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

login

Login IB gateway to a particular account

Usage:

minitrade ib login [OPTIONS]

Options:

Name	Type	Description	Default
-a, --alias	text	IB account alias	None
--help	boolean	Show this message and exit.	False

logout

Logout IB gateway from all accounts

Usage:

minitrade ib logout [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

start

Start IB gateway

Usage:

minitrade ib start [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

status

Check IB gateway status

Usage:

minitrade ib status [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

stop

Stop IB gateway

Usage:

minitrade ib stop [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

init

Initialize Minitrade

Usage:

minitrade init [OPTIONS]

Options:

Name	Type	Description	Default
-y, --yes	boolean	Don't ask for confirmation of inplace upgrade	False
--help	boolean	Show this message and exit.	False

scheduler

Manage scheduler and scheduled jobs

Usage:

minitrade scheduler [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

schedule

Schedule a trade plan

Usage:

minitrade scheduler schedule [OPTIONS] PLAN_ID

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

start

Start scheduler

Usage:

minitrade scheduler start [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

status

Check scheduler status

Usage:

minitrade scheduler status [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

stop

Stop scheduler

Usage:

minitrade scheduler stop [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

unschedule

Unschedule a trade plan

Usage:

minitrade scheduler unschedule [OPTIONS] PLAN_ID

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

web

Manage web UI

Usage:

minitrade web [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

start

Launch web UI

Usage:

minitrade web start [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

:list_subcommands