TICK TOCK NEXT ₿LOCK

Latest Bitcoin data in your terminal:

• blocks
• fees
• price converter BTC/Fiat
• ratio of BTC/Asset pair

Switch between BTC, sat and up to 7 Fiat currencies.

Table of Contents

• Preview
• CLI
• Keybindings
• Installation
• Development
• FAQ
• License

Preview

(theme depends on your terminal preferences btw)

Dashboard

Latest fees

Latest block

Price converter

Ratio BTC/Asset

Menu

CLI

tick-tock-tui --help

Usage: tick-tock-tui [-m|--mempool URL] [-r|--refresh SECONDS]
                     [-s|--storage DIRECTORY] [-i|--ignore]

  Get the latest Bitcoin data in your terminal: fees, blocks, ratio and prices
  incl. a price converter. Most data is provided by Mempool. Connect to your own
  Mempool instance if you like. Latest prices of other assets come from Krakens
  Spot API.

Available options:
  -m,--mempool URL         Mempool URL (default: "https://mempool.space")
  -r,--refresh SECONDS     Interval to auto-reload data in seconds
                           (default: 180)
  -s,--storage DIRECTORY   Folder to store application state
                           (default: "~/.local/state/tick-tock-tui")
  -i,--ignore              Ignore previous stored application state to use
                           default data instead.
  -h,--help                Show this help text

Keybindings

Menu

Key	Description
↑ / ↓ or m	Toggle menu

Screens

Key	Description
0	Dashboard
1	Fees
2	Block
3	Price converter
4	Ratio

Actions

Key	Description
r	Reload data
s	Toggle BTC/sat
t	Toggle Fiat
e	Toggle extra information
a	Toggle animation
q	Quit

Edit mode (converter + ratio only)

Key	Description
Ctrl + e	Enter edit mode
ENTER	Apply changes (in edit mode only)
ESC	Skip changes (in edit mode only)

Installation

Cabal

Run following command from your project directory

cabal install

Nix

NixOS

soon

Home Manager

soon

Development

Requirements

Nix (recommended):

Install Nix. Enable flakes.

cd into project directory to run nix develop. Check out available commands in a next chapter.

Others:

Following needs to be installed:

• Haskell
• cabal
• cabal-fmt
• fourmoulu
• just

When everything is installed, check out all the commands available below.

Commands to build etc.

just --list

Available recipes:
    build              # build app
    format             # format files
    format-check       # check formats
    lint               # lint
    run                # run app
    run-custom url sec # run app with custom args (mempool url + seconds to refresh data)
    test               # run tests

Build demos

Check instructions here.

FAQ

Where all the data is coming from?

Most data is fetched from Mempool REST API. Connect to your private Mempool instance if you like (see next question).

To calculate a BTC/Asset ratio Kraken Spot Rest API is used to get latest prices for other assets.

How to connect to a custom Mempool instance?

Start the app with -m parameter:

cabal run tick-tock-tui -- -m {custom-mempool-url}

Do I need an API key to get asset price data from Kraken's API?

Nope. Quote from Kraken Support page:

"API keys are not required to call the market data (public) API endpoints, as the market data endpoints are not associated with any specific Kraken account."

Is any data stored locally?

Yes, users settings are stored locally. That's needed to start the app with the latest user settings. Locations to persist data are defined by XdgState:

• non-Windows ~/.local/state/tick-tock-tui/data{version}.json
• Windows: %LOCALAPPDATA% (e.g. C:/Users/<user>/AppData/Local/tick-tock-tui/data{version}.json)

License

MIT License