https://github.com/kruemelmann/komodo
Small command line tool for relaxed writing of LaTex from the console and see it in the browser
https://github.com/kruemelmann/komodo
cli latex terminal
Last synced: 6 months ago
JSON representation
Small command line tool for relaxed writing of LaTex from the console and see it in the browser
- Host: GitHub
- URL: https://github.com/kruemelmann/komodo
- Owner: Kruemelmann
- License: mit
- Created: 2022-04-10T18:43:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-09T11:00:41.000Z (10 months ago)
- Last Synced: 2025-09-09T14:11:25.462Z (10 months ago)
- Topics: cli, latex, terminal
- Language: Go
- Homepage: http://kruemelmann.github.io#komodo
- Size: 1.75 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# komodo
Komodo is small command line tool for latex writing from the console.
## Requirements
Before you can start using komodo you need to install:
* pdflatex
Linux
```bash
sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
```
Mac
```bash
brew install basictex
```
## Installation
```bash
sudo curl -L "https://github.com/kruemelmann/komodo/releases/download/v0.1.19/komodo-$(uname -s)-$(uname -m)" -o /usr/local/bin/komodo && sudo chmod +x /usr/local/bin/komodo
```
## Usage
### Build command
#### Simply build pdf from LaTex File
```bash
komodo build -f .tex
```
#### Build pdf from LaTex with a watcher
(You dont need to run the script everytime you change the tex-File)
```bash
komodo build -w -f .tex
```
### Serve command
#### Build pdf (with watcher) and serve it to your browser
(The ui has hot reload of course otherwise the watcher in the backend would be useless)
```bash
komodo serve -f .tex
```
#### Serve on a different port
The default port of komodo is 9090 but if you want to start it on a different port you can simply do this with the port flag.
```bash
komodo serve -p 8081 -f .tex
```
If you like to run komodo on a random free port you can add the random_port flag
```bash
komodo serve --random_port -f .tex
```
### Getting help
To print the Helppage of komodo just run its basecommand:
```bash
komodo
```
Or add the -h flag:
```bash
komodo -h
```
If you need help with a subcommand like serve or build just run:
```bash
komodo -h
```
## Supported platforms
At the moment I only support x86 or ARM based Mac or x86 Linux in komodo but if you want to use another platform and can't build komodo from source you can open an issue and I will integrate a build for your preferred platform in the CI pipeline.
## Contributing
Pull requests welcome:)
If you like to do some bigger changes please open an issue, so we can chat about.
## Authors
* kruemelmann - [@kruemelmann](https://github.com/kruemelmann/)
## License
[MIT](https://choosealicense.com/licenses/mit/)