# ⛵ seeport
> crypto portfolio viewer that has a terminal user interface and uses toml for input data

## How to use
Install with cargo `cargo install seeport`.  
You can run the application in your terminal `$ seeport`.  

When you first open the application there will be no assets in your portfolio.
You can add assets to your portfolio by editing 
`portfolio.toml` located in the config directory of your OS e.g. (linux) `~/.config/seeport/seeport.toml`.
As you can read from the file extension the portfolio is a [toml](https://toml.io) file which means that you define what assets you have in the toml language.
If don't know toml you can read the spec [here](https://toml.io/en/v1.0.0).

### Here is an example portfolio.toml:
```toml
[monero]
buy = [
    { price = 142.60, quantity = 1.2, date = "2022-04-21" }
]
sell = [
    { price = 152.3, quantity = 0.7, date = "2022-05-02" }
]

[wonero]
buy = [
    { price = 0.057099, quantity = 5000, date = "2022-01-20" }
]
sell = [
    { price = 0.046, quantity = 4600, date = "2022-07-22" }
]
```
This portfolio has assets monero and wownero.
You input your portfolio with buy and sell transactions.

## Settings
Settings are in the `seeport.toml` located in your Configuration Directory e.g. `~/.config/seeport/seeport.toml`.
Fields you can set:
* **Editor** Defaults to $EDITOR with fallback `nano`
* **Versus** The currency used for pricing

### Example
```toml
editor = "emacs"
versus = "CHF"
```