CBBI
# ColinTalksCrypto Bitcoin Bull Run Index (CBBI)  [](https://github.com/Zaczero/CBBI) The official Python implementation of the **ColinTalksCrypto Bitcoin Bull Run Index** (CBBI). The CBBI is a Bitcoin index that utilizes advanced, real-time analysis of 9 metrics to help us understand what stage of the Bitcoin bull run and bear market cycles we are in. The CBBI is time-independent and price-independent. It simply indicates whether it believes we are approaching the top/bottom of a Bitcoin cycle. If you want to learn more, [check out this video](https://www.youtube.com/watch?v=bq7djf1n0j4). ## Visit our website Bookmark it and receive latest CBBI updates. - [CBBI.info](https://cbbi.info/) ## Script Demo [](https://asciinema.org/a/KFkbKPULf9PGvY8Fmh4QLn0FE) ## Docker Usage To use the CBBI script with Docker, run the following command: ```sh docker run --rm --pull=always zaczero/cbbi --help docker run --rm --pull=always zaczero/cbbi ``` ## Manual Usage To use the CBBI script without Docker, follow these two simple steps: ### 1. Install nix Before you jump in, make sure to install the [❄️ Nix](https://nixos.org/download) package manager. It's your shortcut to seamless dependency management and reproducible environment setup. It will save you lots of time and spare you from unnecessary stress. ### 2. Run the application ```sh nix-shell --run "python main.py --help" ``` #### or with using interactive shell ```sh nix-shell python main.py --help ``` ## Metrics The current CBBI version _(November 2022)_ includes the following metrics: | Name | Link | | ---------------------------- | --------------------------------------------------------------------- | | Pi Cycle Top Indicator | [Visit page](https://coinank.com/indexdata/piCycleTop) | | RUPL/NUPL Chart | [Visit page](https://coinank.com/indexdata/realizedProf) | | RHODL Ratio | [Visit page](https://coinank.com/indexdata/rhodlRatio) | | Puell Multiple | [Visit page](https://coinank.com/indexdata/puellMultiple) | | 2 Year Moving Average | [Visit page](https://coinank.com/indexdata/year2MA) | | Bitcoin Trolololo Trend Line | [Visit page](https://www.blockchaincenter.net/bitcoin-rainbow-chart/) | | MVRV Z-Score | [Visit page](https://coinank.com/indexdata/score) | | Reserve Risk | [Visit page](https://coinank.com/indexdata/reserveRisk) | | Woobull Top Cap vs CVDD | [Visit page](https://woocharts.com/bitcoin-price-models/) | ## Environment Variables This project supports `.env` files, which provide a convenient way of setting environment variables. To use this feature, create a file called `.env` in the project's root directory, and add environment variables in the following format: ```sh VARIABLE_NAME=value ``` ### TELEGRAM_TOKEN, TELEGRAM_CHAT_ID Define both variables to receive Telegram notifications about metric errors that occur during the execution. #### Example usage - TELEGRAM_TOKEN=REPLACE_ME - TELEGRAM_CHAT_ID=123456 ## Footer ### Contact me <https://monicz.dev/#get-in-touch> ### License This project is licensed under the GNU Affero General Public License v3.0. The complete license text can be accessed in the repository at [LICENSE](https://github.com/Zaczero/CBBI/blob/main/LICENSE).