mirror of https://github.com/miguelmota/cointop
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
---
|
|
title: "Getting started"
|
|
date: 2020-01-01T00:00:00-00:00
|
|
draft: false
|
|
---
|
|
# Getting started
|
|
|
|
After [installing](/install), run the `cointop` command to get started:
|
|
|
|
```bash
|
|
$ cointop
|
|
```
|
|
|
|
To see all the available commands and options run `help` flag:
|
|
|
|
```bash
|
|
$ cointop --help
|
|
```
|
|
|
|
### Navigation
|
|
|
|
- Easiest way to navigate up and down is using the arrow keys <kbd>↑</kbd> and <kbd>↓</kbd>, respectively
|
|
- To go the next and previous pages, use <kbd>→</kbd> and <kbd>←</kbd>, respectively
|
|
- To go to the top and bottom of the page, use <kbd>g</kbd> and <kbd>G</kbd> (Shift+g), respectively
|
|
- Check out the rest of [shortcut](/shortcuts) keys for vim-inspired navigation
|
|
|
|
### Favorites
|
|
|
|
- To toggle a coin as a favorite, press <kbd>Space</kbd> on the highlighted coin
|
|
- To view all your favorite coins, press <kbd>F</kbd> (Shift+f)
|
|
- To exit out of the favorites view, press <kbd>F</kbd> (Shift+f) again or <kbd>q</kbd>
|
|
|
|
### Portfolio
|
|
|
|
<img src="https://user-images.githubusercontent.com/168240/50439364-a78ade00-08a6-11e9-992b-af63ef21100d.png" alt="portfolio screenshot" width="880" />
|
|
|
|
- To add a coin to your portfolio, press <kbd>e</kbd> on the highlighted coin
|
|
- To edit the holdings of coin in your portfolio, press <kbd>e</kbd> on the highlighted coin
|
|
- To view your portfolio, press <kbd>P</kbd> (Shift+p)
|
|
- To exit out of the portfolio view press, <kbd>P</kbd> (Shift+p) again or <kbd>q</kbd>
|
|
|
|
### Search
|
|
|
|
- To search for coins, press <kbd>/</kbd> then enter the search query and hit <kbd>Enter</kbd>
|
|
|
|
### Base Currency
|
|
|
|
- To change the currency, press <kbd>c</kbd> then enter the character next to the desired currency
|
|
|
|
<img src="https://user-images.githubusercontent.com/168240/41806841-043c0ca6-767a-11e8-9c51-df9fc64b3b5c.png" alt="currency convert menu" width="880" />
|
|
|
|
### Help Menu
|
|
|
|
- To view the help menu, press <kbd>?</kbd>
|
|
|
|
<img src="https://user-images.githubusercontent.com/168240/39569662-bcbdbcc0-4e7a-11e8-8a8f-8ff45868a8ae.png" alt="help menu" width="880" />
|