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
|
.TH TICK "1" "January 2018" "Tick 1.8.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. Then, use the option "check" to get information on the current price.
.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] [currency name/crypto_id/all]
Prints information about your current portfolio holdings. Either a symbol or the keyword 'all' can be used. The keyword "all"
will print information about all your current holdings, as well as a grand total. Running only 'tick check' will do the same
thing as 'tick check all'.
.TP
[convert]
If it exists, removes $HOME/.tick_portfolio.json and adds your current holding from the legacy portfolio, located at
$HOME/.tick_portfolio.
.TP
[encrypt/decrypt]
Encrypts or decrypts your portfolio using the RC4 algorithm. Password must be 32 characters or less.
.SS
News:
.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 all
.RE
To get the top three news articles on Tesla in the past two weeks, run
.RS
$ tick news 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.
|