1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
.TH TICK "1" "May 2018" "Tick 2.1.0" "User Commands"
.SH NAME
Tick - Command line stock and cryptocurrency portfolio tracker.
.SH SYNOPSIS
tick COMMAND [ARGUMENTS]
.SH DESCRIPTION
Create your portfolio by adding your current holdings. You can see information about your holdings with the command "check".
You may also see information about securities that you may not own with commands "info" and "news".
.SS
Portfolio:
.TP
[add/rm/set] [symbol/crypto_id/USD$] [quantity of shares] [USD spent/SharePriceEA]
Either adds, removes, or sets the amount of the given stock with respect to the given values. The parameter "add" will add
your input to the current portfolio, "rm" will subtract from your current portfolio, and "set" will set your portfolio to
the input, discarding any existing data about that security. Trading fees should be factored into "USD SPENT". As an exception,
cryptocurrencies must be specified by their name (e.g. "ripple", instead of "xrp"), due to duplicate tickers in both the
US stock market and the cryptocurrency market. You may also input as "usd$" for US Dollars. This is helpful for keeping
track of how much money is unallocated in your brokerage account. Typically, your initial amount of USD can be added as
"tick add USD$ [amount] [amount]", where [amount] is the same number. When you are paid dividends or capital gains that
are not reinvested into a specific security, you should update your portfolio with "tick add USD$ [dividend/capital gain amount] 0".
You may also specify the share price instead of the total amount you spent by appending "ea" to the end of the share price.
.TP
[check] [symbol/crypto_id/sort_option]
Prints information about your current portfolio holdings. To print all of your holdings alphabetically as well as a
grand total, no additional arguments besides "check" need to be used. Optionally, you may use the options "-a" to print
alphabetically, "-v" to print by value, "-p" to print by profit, "-1" to print by one day profit, or "-7" to print by
seven day profit. To print information about a single security, use the ticker or crypto id as an argument after "check".
.TP
[encrypt/decrypt]
Encrypts or decrypts your portfolio using the RC4 algorithm. Password must be 32 characters or less.
.SS
Security Information:
.TP
[info] [symbol]
Prints information on the given security. This includes company name, current and historical price, dividends, market cap,
and volume.
.TP
[graph] [symbol]
Prints a graph of the historic price of the given security. Cryptocurrencies aren't supported yet, due to API constraints.
You may press the UP arrow key to zoom in, the DOWN arrow key to zoom out, the LEFT arrow to pan left, the RIGHT arrow
to pan right, or the letter "q" to quit.
.TP
[cmp] [symbol] [symbol]
Same functionality to "graph", but is intended for comparing two securities. The command takes two symbols as
arguments. Both graphs will be displayed.
.TP
[news] [symbol]
Prints information on the top three news articles in the past 14 days. The article titles, sources, authors, dates, and URLs
will be displayed. If you would like to use a space in your search, you must either use an underscore instead of the space or wrap
your phrase in double quotes. Technically, the input may be something completely unrelated to investing. This may be amended
in the future.
.SH EXAMPLES
To add 3 shares of Tesla bought for $918.12 total, run
.RS
$ tick add tsla 3 918.12
.RE
You can also specify the price per share instead of total spent:
.RS
$ tick add tsla 3 306.04ea
.RE
To get info about your current holdings in a Tesla, run
.RS
$ tick check tsla
.RE
Or to get info about all your holdings, run
.RS
$ tick check
.RE
or to sort by value
.RS
$ tick check -v
.RE
To get the top three news articles on Tesla in the past two weeks, run
.RS
$ tick news tesla
.RE
To get information on Tesla, run
.RS
$ tick info tesla
.SH FILES
.I ~/.tick_portfolio.json
.RS
Portfolio file.
.RE
.I ~/.tick_portfolio
.RS
Portfolio file (legacy).
.SH GITHUB
Please report any bugs using the GitHub issue tracker:
https://github.com/aokellermann/tick/issues
.SH AUTHORS
Antony Kellermann -- https://github.com/aokellermann
.SH LICENSE
MIT License
Stock information is taken from IEX's free API. Mutual fund and over-the-counter
information is taken from Morningstar's free API. Cryptocurrency information
is taken from Coinmarketcap's free API. News information is taken from News
API. Shortened links are provided by Google's URL Shortener API. Please do
not abuse the APIs by repeatedly requesting information. Read the provided
license for more information.
|