Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 2.42 KB

README.md

File metadata and controls

95 lines (68 loc) · 2.42 KB
Raw

komodo

build status release status

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

    sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra

    Mac

    brew install basictex

Installation

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

komodo build -f <filename>.tex

Build pdf from LaTex with a watcher

(You dont need to run the script everytime you change the tex-File)

komodo build -w -f <filename>.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)

komodo serve -f <filename>.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.

komodo serve -p 8081 -f <filename>.tex

If you like to run komodo on a random free port you can add the random_port flag

komodo serve --random_port -f <filename>.tex

Getting help

To print the Helppage of komodo just run its basecommand:

komodo

Or add the -h flag:

komodo -h

If you need help with a subcommand like serve or build just run:

komodo <subcommand> -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

License

MIT