https://github.com/n0rdy/calcli
An overengineered (for fun) cross-platform CLI calculator app with the rich set of features
https://github.com/n0rdy/calcli
antlr antlr4 calculator calculator-application cli cobra-cli cross-platform go golang
Last synced: about 1 month ago
JSON representation
An overengineered (for fun) cross-platform CLI calculator app with the rich set of features
- Host: GitHub
- URL: https://github.com/n0rdy/calcli
- Owner: n0rdy
- License: agpl-3.0
- Created: 2024-07-30T15:32:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-23T10:56:39.000Z (4 months ago)
- Last Synced: 2025-11-23T12:22:22.978Z (4 months ago)
- Topics: antlr, antlr4, calculator, calculator-application, cli, cobra-cli, cross-platform, go, golang
- Language: Go
- Homepage:
- Size: 968 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CalCLI - a CLI calculator
An overengineered (because it's fun) cross-platform CLI calculator app with a rich set of [features](#features).
It is handy if you need to do some quick calculations while hacking in the terminal - no need to open a calculator app of any kind.
The flow of the app is as follows:
## Table of contents
* [Installation](#installation)
* [Prerequisites](#prerequisites)
* [Manual](#manual)
* [MacOS](#macos)
* [Linux](#macos)
* [via APT](#via-apt)
* [Prerequisites](#prerequisites-1)
* [Installation](#installation-1)
* [via YUM](#via-yum)
* [Prerequisites](#prerequisites-2)
* [Installation](#installation-2)
* [Usage](#usage)
* [Features](#features)
## Installation
### Prerequisites
- [Go](https://golang.org/doc/install) (version 1.22 or higher) if you want to build the app from the source code.
### Manual
Download the latest release for your OS from [GitHub](https://github.com/n0rdy/calcli/releases).
### MacOS
- via Homebrew:
```shell
brew tap n0rdy/n0rdy
brew install calcli
```
### Linux
#### via APT
##### Prerequisites
To enable, add the following file /etc/apt/sources.list.d/fury.list:
```text
deb [trusted=yes] https://apt.fury.io/n0rdy/ /
```
You can do this either manually or by running the following command:
```shell
echo "deb [trusted=yes] https://apt.fury.io/n0rdy/ /" > /etc/apt/sources.list.d/fury.list
```
If you experienced this error:
```text
bash: /etc/apt/sources.list.d/fury.list: Permission denied
```
try to do the following:
```shell
sudo -i
# enter your password
echo "deb [trusted=yes] https://apt.fury.io/n0rdy/ /" > /etc/apt/sources.list.d/fury.list
# click Ctrl+D to exit
```
##### Installation
```shell
sudo apt update && sudo apt install calcli
```
#### via YUM
##### Prerequisites
To enable, add the following file /etc/yum.repos.d/fury.repo:
```text
[fury]
name=Gemfury n0rdy Private Repo
baseurl=https://yum.fury.io/n0rdy/
enabled=1
gpgcheck=0
```
##### Installation
```shell
sudo yum install calcli
```
## Usage
```shell
calcli
```
This will start the app in the interactive mode.
Type your expression and press Enter to get the result.
Press `Ctrl+C` or `Esc` to exit the app.
Check the bottom of the screen for the help message with the list of available commands and hotkeys.
## Features
- basic arithmetic operations: `+`, `-`, `*`, `/`, `%`, `^`, `!`, as well as parentheses
- integer and floating-point numbers (`.` as a decimal separator)
- a set of predefined constants: `pi`, `e`
- math functions:
- `abs(x)` - the absolute value of `x`
- `acos(x)` - the arccosine of `x`
- `asin(x)` - the arcsine of `x`
- `atan(x)` - the arctangent of `x`
- `ceil(x)` - the smallest integer value greater than or equal to `x`
- `cos(x)` - the cosine of `x`
- `exp(x)` - the value of `e^x`
- `exp2(x)` - the value of `2^x`
- `floor(x)` - the largest integer value less than or equal to `x`
- `ln(x)` - the natural logarithm of `x`
- `log(x, base)` - the logarithm of `x` to the specified `base`
- `log2(x)` - the base-2 logarithm of `x`
- `log10(x)` - the base-10 logarithm of `x`
- `mod(x, y)` - the remainder of the division of `x` by `y`
- `nrt(x, degree)` - the root of `x` of the specified `degree`
- `percent(x, y)` - the percentage of `x` from `y`
- `round(x)` - the value of `x` rounded to the nearest integer
- `sin(x)` - the sine of `x`
- `sqrt(x)` - the square root of `x`
- `tan(x)` - the tangent of `x`
- the result of the previous calculation is stored in the variable `$pr` and can be used in further calculations
- it is possible to persist the result of the calculation or a value in the variable and use it in further calculations `$var = 5 + 5`
- calling `pmem()` system function will print all the variables stored in memory
- review the history of calculations by pressing the `Up` and `Down` arrow keys, or switching to the history mode by typing `:h` and pressing `Enter`
- in history mode, press `/` to search for a specific expression in the history
Have fun! =)