Well, you got this far, that's great! Go fill up your favorite drink and get ready to read, this will be a long one. But by the time your done with this, you will be a Trade Dangerous Master! Lets continue!

trade.py is a front-end to several tools - a trade run calculator, a tool for updating prices at a given station, and more to come.

You can type "trade.py -h" for basic usage, or for help on a specific sub- command, you can use "trade.py command -h" for example

trade.py run -h

will show you how to use the 'run' sub-command.

• --detail
• -v

Increases the amount of detail given when showing routes or running the checklist system. Each use increases the detail, i.e. "-v -v" will give you more detail than just "-v". Short version stacks, e.g. "-v -v -v" is the same as "-vvv"

• --quiet
• -q

Reduces the verbosity of the program. For example, trade.py -qq cleanup. Will run the command with no output unless an error occurs.NOTE: "--detail" and "--quiet" are mutually exclusive.

• --debug
• -w

Gives some additional information on what TD is doing while running, each use increases the verbosity: i.e. --debug --debug is more verbose. Short version is stackable, e.g. "-w -w -w" or "-www"

trade.py run ... Calculates a trade run.

trade.py update ... Provides an interface for updating the prices at a station.

======================WORK IN PROGRESS

RUN sub-command:

This command provides the primary trade run calculator functionality (it provides the functionality of the older TradeDangerous versions prior to 3.1)

Route options: --from <station or system> Lets you specify the starting station e.g. --from Dahan --from Gateway

--to <station or system> Lets you specify the final destination e.g. --to Beagle2 --to Aulin

--via <station or system> Lets you specify a station that must be between the second and final hop. Requires that hops be at least 2. e.g. --via Enterprise --via Chango

--unique --uni Only show routes which do not visit any station twice

--hops N DEFAULT: 2 Maximum number of hops (number of cargo pickups) e.g. --hops 8

--jumps-per N --jum N DEFAULT: 2 Limit the number of systems jumped to between each station e.g. -jumps-per 5

--ly-per N.NN --ly N.NN DEFAULT: based on --ship Maximum distance your ship can jump between systems at full capacity. NOTE: You can increase your range by selling your weapons. e.g. --ly-per 19.1 --ly-per 3

Ship/Trade options: --capacity N --cap N DEFAULT: based on --ship Maximum items you can carry on each hop.

--credits N --cr N How many credits to start with e.g. --credits 20000

--insurance N DEFAULT: 0 --ins N How many credits to hold back for insurance purposes e.g. --insurance 1000 --ins 5000

--limit N DEFAULT: 0 If set, limits the maximum number of units of any cargo item you will buy on any trade hop, incase you want to hedge your bets or be a good economy citizen. e.g. --capacity 16 --limit 8

--avoid ITEM/SYSTEM/STATION --avoid AVOID,AVOID,...,AVOID --av ITEM/SYSTEM/STATION --av AVOID,AVOID,...,AVOID Excludes the item/system/station matching the name from the database e.g. --avoid Gold --avoid Aulin --avoid Enterprise --avoid prise --av gold,aulin,enterprise,anderson

--margin N.NN DEFAULT: 0.01 At the end of each hop, reduce the profit by this much (0.02 = 2%), to allow a margin of error in the accuracy of prices. e.g. --margin 0 (no margin) --margin 0.01 (1% margin)

Other options: --routes N DEFAULT: 1 Shows the top N routes;

--checklist --check Walks you through the purchases, sales and jumps of your route. Note: More verbose when used with --detail

--x52-pro --x52 OMFG Output the current step of the checklist on your X52 Pro MFD. Is that some sweetness or what?

UPDATE sub-command:

For maintenance on your local prices database. The default is to walk you through a list of all the prices known for the station. You can either hit enter or type the correction.

Alternatively, if you specify one of the editing switches, it will put the prices for a given station into a text file and let you edit it with your favorite editor.

trade.py update [--editor <executable> | --sublime | --notepad | --npp | --vim] station

--editor <executable name or path> e.g. --editor "C:\Program Files\WibbleEdit\WibbleEdit.exe" Saves the prices in a human-readable format and loads that into an editor. Make changes and save to update the database.

--all Exposes timestamp, demand and stock value columns.

--zero Requires --all Causes unknown demand/stock levels to show as 0 instead of -1. Use this when you are actively editing those fields and the -1s get in your way.

--sublime --subl Like "--editor" but finds and uses the Sublime Text editor (2 and 3). You can use "--editor" to tell it exactly where the editor is located if it fails to find it.

--notepad --note Like "--editor" but uses notepad as the editor.

--npp Like "--editor" but tries to use Notepad++ as the editor. NOTE: You will have to exit notepad++ completely before trade is able to process the changes you have made.

--vim Like "--editor" but tries to use the VI iMproved editor. Mostly applies to Linux, Mac and Cygwin/Git installs.

Examples: trade.py update "aulin enterprise" --notepad trade.py update chango --subl trade.py update anderson --editor "C:\Program Files\Microsoft Office\WordPad.exe" trade.py update wcm

NAV sub-command:

Provides details of routes without worrying about trade. By default, if given a ship, it uses the max dry range of the ship. Use --full if you want to restrict to routes with a full cargo hold.

trade.py [-q | -v] nav [--ship name [--full]] [--ly-per] from to

--ship name Uses the values for an empty ship to constrain jump ranges, --ship=ana --ship type6 --ship 6

--full Used with --ship, uses the max range of the ship with a full load, --ship cobra --full

--ly-per N.NN Constrains jumps to a maximum ly distance --ly-per 3.2

from Name of the starting system or a station in the system,

to Name of the destination system or a station in the system,

Examples: > trade.py nav --ship=type6 5287 2887 From LHS 5287 to LHS 2887 with 29.36ly per jump limit. System (Jump Ly) ---------------------------------------- LHS 5287 ( 0.00) I BOOTIS ( 19.94) LHS 2887 ( 17.14)

> trade.py -v nav --ship=type6 --full 5287 2887 From LHS 5287 to LHS 2887 with 15.64ly per jump limit. Action | System | Jump Ly | Total Ly ------------------------------------------------------------ Depart | LHS 5287 | 0.00 | 0.00 Via | ASELLUS PRIMUS | 14.47 | 14.47 Via | BD+47 2112 | 11.81 | 26.28 Arrive | LHS 2887 | 11.73 | 38.01

LOCAL sub-command:

Provides details of local stations without worrying about trade. By default, if given a ship, it uses the max dry range of the ship. Use --full if you want to restrict to systems with a full cargo hold.

trade.py [-q | -v] local [--ship name [--full]] [--ly N.NN] [--pill | --percent] system

--ship name Uses the values for an empty ship to constrain jump ranges, --ship=ana --ship type6 --ship 6

--full Used with --ship, uses the max range of the ship with a full load, --ship cobra --full

--ly N.NN Constrains local systems to a maximum ly distance --ly 20.0

--pill Show estimated length along the Pill in ly

--percent Like --pill but shows percentage instead

-v Show stations

system Name of the system or a station in the system,

Examples: > trade.py local --ly 11.0 dahan Local systems to DAHAN within 11.0 ly. -------------------------------------- 4.66 Asellus Primus 5.12 Morgor 6.41 Eranin 8.26 Meliae 8.58 LHS 2884 8.60 LP 98-132 9.20 Aulis 9.75 GD 319 10.08 BD+47 2112 10.33 i Bootis

> trade.py -v local --ly 11.0 sur Local systems to SURYA within 11.0 ly. -------------------------------------- 9.22 [ 2.2] 14 Herculis 9.23 [ 1.0] Vaccimici 9.35 [ 10.0] CM Draco 10.59 [ 10.3] V1090 Herculis 10.69 [ -1.6] Chi Herculis

> trade.py -vv local --ly 10.0 3006 Local systems to LHS 3006 within 10.0 ly. ----------------------------------------- 5.64 [ 0.4] Acihaut <Cuffey Plant> <Mastracchio Base> 6.00 [ 5.1] G 239-25 <Bresnik Mine> 6.47 [ 1.1] Nang Ta-khian <Hay Point> <Hadwell Orbital> 7.51 [ -0.0] Eranin <Azeban City> <Azeban Orbital> <Eranin 4 Survey> 7.74 [ -4.9] Aulin <Aulin Enterprise> <Harbaugh Station> <Onufrienko Station> 8.12 [ -2.8] i Bootis <Chango Dock> <Maher Stellar Research> 8.52 [ -6.4] BD+47 2112 <Olivas Settlement> 8.78 [ 7.9] Lalande 29917 9.40 [ 5.7] DN Draconis 9.72 [ 4.9] LP 98-132 <Freeport> <Prospect Five>