Skip to content

Repository files navigation

Cloud LaTeX CLI

CLI interface is under development. Check VSCode CloudLaTeX Extension if you are a VSCode user.

*** Write locally and compile on cloud service.

Cloud LaTeX CLI is an official tool written in nodejs to write tex files locally and compile with Cloud LaTeX.

You can write tex files with your favorite editor and compile them without installing very large latex compiler!

If you use VSCode, you can use Cloud LaTeX VSCode Extension.

⚠Following sections is under development and not completed.

Features

  • Multi-platform
  • Offline support

Installation (Not Released yet)

npm install -g cloudlatex-cli

Account Settings

If you have no Cloud LaTeX account, you need to create your account from here.

Create your project which you want to edit locally on the web page.

Generate client id and token from [Account name] -> [Extension] at the project page and record them.

Usage

On your latex directory, run the following command.

* For the first time, the directory should be empty, otherwise local files on the directory will be overwritten.

cloudlatex-cli --path ./  \
  --outdir ./workspace \
  --project [Your ProjectId] \
  --email [Your email address used for CloudLaTeX account] \
  --client [Your client id] \
  --token [Your token] 

Then, your project files will be downloaded. Local file changes will be synchronized with the Cloud LaTeX server and compilation is fired on the server.

After the second time, run the same command as before.

* File changes when this tool is not running are not synchronized.

Development

Use Node.js 24 LTS and Yarn Classic (1.22.x).

yarn install --frozen-lockfile
yarn run lint
yarn run test
yarn run build

Tests use ts-node to compile TypeScript. The Mocha configuration disables Node's built-in type stripping so parameter properties and the project tsconfig are handled by ts-node.

License

Apache License 2.0

About

No description, website, or topics provided.

Resources

Stars

5 stars

Watchers

6 watching

Forks

Releases

Packages

Used by

Contributors

Languages