rustfolio 1.0.0

A simple tool for monitoring an investment portfolio
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

# Rustfolio

Rustfolio is a program for monitoring your investment portfolio. It's main purpose is to show a summary of all your assets and their share in the entire portfolio. The portfolio data is stored in a `.csv` file, so it can be imported into any spreadsheet processor like Libre Office Calc or Microsoft Exel for more complicated processing and analisys. The files are stored in `~/.local/share/rustfolio` directory.

![Showcase](screenshots/showcase.png)

## Installation

### With Cargo

[Install](https://www.rust-lang.org/tools/install) Cargo and Rust. Once Cargo is in your $PATH, run

```sh
cargo install rustfolio
```

### From binary

Grab the latest binary for your platform on Github [releases](https://github.com/Melesar/rustfolio/releases) page. Put the binary somewhere in your $PATH. Run `rustfolio -V` to make sure it is installed properly.

## Example usage

### Show the portfolio "MyPortfolio"

```sh
rustfolio --file MyPortfolio
```

`--file` flag can be omitted. In this case the program will promt to select the portfolio that exists.
To see the entire history of the portfolio instead of the latest entry, add `--table` flag

```sh
rustfolio --file MyPortfolio --table
```

### Create a new portfolio

```sh
rustfolio new MyPortfolio
```

If the portfolio name is not specified, the program will ask you to enter it. There is also an option to read the name from `stdin`. To do that, add `--read-name` flag and leave the argument empty.

### Modify a portfolio

```sh
rustfolio add --file MyPortfolio
```

The program will promt you to provide data for each asset category in the portfolio and will save it in the specified file. If `--file` is omitted, it will promt to select an existing portfolio. If none exists, it will promt to create a new one.

Every time you `add` to an existing portfolio, this data will be added to the portfolio .csv file with the current date and time. This way, you will have a history of your portfolio

### List available portfolios

```sh
rustfolio list
```

### Export a portfolio as a .csv file

```sh
rustfolio export -o output.csv --file MyPortfolio
```

Flag `--file` can be omitted. In this case you will be promted to select one of the available portfolios

## Usage in scripting

Rustfolio allows to use all above commands in non-interactive move using pipes and stream redirections. For example, suppose that there is a file `input.txt` with a following content:

```
one
123
two
432
three
242
```

Than `cat input.txt | rustfolio new MyPortfolio` will generate the following portfolio:

![Non-interactive new](screenshots/non-interactive-new.png)

The same effect can be achieved with `--read-name` flag. In this case the `input.txt` must look as following:

```
MyPortfolio
one
123
two
432
three
242
```

And the command will be: `cat input.txt | rustfolio new --read-name`

## License

The project is licensed under MIT license. See [LICENSE](https://github.com/Melesar/rustfolio/blob/development/LICENSE) file for details.