Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paperist/cli
CLI for Paperist
https://github.com/paperist/cli
Last synced: 15 days ago
JSON representation
CLI for Paperist
- Host: GitHub
- URL: https://github.com/paperist/cli
- Owner: Paperist
- License: mit
- Created: 2017-10-30T07:28:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-14T19:01:16.000Z (about 7 years ago)
- Last Synced: 2023-09-18T23:58:53.978Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 86.9 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @paperist/cli
[![LICENSE][license-badge]][license]
[![NPM][npm-badge]][npm]
[![standard-readme compliant][standard-readme-badge]][standard-readme]
[npm]: https://www.npmjs.com/package/@paperist/cli
[license]: https://3846masa.mit-license.org
[standard-readme]: https://github.com/RichardLitt/standard-readme
[npm-badge]: https://img.shields.io/npm/v/@paperist/cli.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgBAMAAACBVGfHAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAbUExURcwAAOeIiP////G7u/ri4tIZGdpFReJsbPC3t075sZwAAAAvSURBVCjPY2CgDWAThIMEsACjEhwIUCZg0dGCIqASwMAxMgXAgSzOwMAOC2TqAwBvzR4JxLaP0gAAAABJRU5ErkJggg==
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQBAMAAADt3eJSAAAAIGNIUk0AAHomAACAhAAA%2BgAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAAVUExURSBTICJcIiNgIiZoJTuhNyt3Kf///%2BCqxSgAAAAGdFJOUwpclbn%2B4Fj6/H8AAAABYktHRAZhZrh9AAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4AkEEjEV7MDQQwAAAGBJREFUCNc1TUEKgDAMi07vE/Q%2BRD8g%2B4BbvAvi/79iMjDQJm1CC6BbDzRsZI3incIpYeYFhCaYnLiyPYnYkwWZFWoFHrSuttCmmbwXh0eJQYVON4JthZTxCzzAmyb8%2BAAKXBRyN6RyZQAAAABJRU5ErkJggg==
[standard-readme-badge]: https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square
> CLI for Paperist
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Init project](#init-project)
- [Build PDF](#build-pdf)
- [Watch project](#watch-project)
- [Install templates](#install-templates)
- [Uninstall templates](#uninstall-templates)
- [Contribute](#contribute)
- [License](#license)
## Install
```
npm install --global @paperist/cli
```
**--- OR ---**
Download from [releases](https://github.com/Paperist/cli/releases)
## Usage
### Init project
```
paperist init ./new-project
```
### Build PDF
```
paperist build
```
### Watch project
```
paperist watch
```
### Templates
#### Install templates
Install template from GitHub.
```
paperist template install paperist/template-example
```
If you want to install with examples, append `--with-example` or `-w` flags.
```
paperist template install paperist/template-example --with-example
```
Support GitHub / GitLab / Bitbuckets.
```
# If template dosen't exist on GitHub, add prefix.
paperist template install gitlab:paperist/template-example
```
#### Uninstall templates
Only remove plugin dependencies.
```
paperist template uninstall paperist/template-example
```
## Contribute
PRs accepted.
## License
![3846masa] MIT (c) 3846masa
[3846masa]: https://www.gravatar.com/avatar/cfeae69aae4f4fc102960f01d35d2d86?s=50