# sushi-tool > Tool to generate CoderDojo sushi templates Latest version **0.4.0** (published 2016-08-16) · MIT license · 0 weekly downloads ## Install ```sh npm install sushi-tool pnpm add sushi-tool yarn add sushi-tool bun add sushi-tool ``` Provides the commands `chopsticks`, `sushi-tool`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.4.0 | | Published | 2016-08-16 | | First published | 2016-07-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 23 | | Known vulnerabilities | 0 (+3 in 2 direct dependencies) | | Install scripts | yes | | GitHub stars | 3 | | Author | CoderDojo Foundation | | Maintainers | diegogd, philhar | | Keywords | chopsticks, sushi cards, coderdojo | ## Links - npm: https://www.npmjs.com/package/sushi-tool - Repository: https://github.com/CoderDojo/sushi-tool - Issues: https://github.com/CoderDojo/sushi-tool/issues - npm.io page: https://npm.io/package/sushi-tool ## Dependencies (23) - [os](https://npm.io/package/os.md) ^0.1.1 - [glob](https://npm.io/package/glob.md) ^7.0.5 - [harp](https://npm.io/package/harp.md) ^0.20.3 - [i18n](https://npm.io/package/i18n.md) ^0.8.3 - [open](https://npm.io/package/open.md) 0.0.5 - [async](https://npm.io/package/async.md) ^2.0.1 - [bower](https://npm.io/package/bower.md) ^1.7.9 - [color](https://npm.io/package/color.md) ^0.11.3 - [colors](https://npm.io/package/colors.md) ^1.1.2 - [express](https://npm.io/package/express.md) ^4.14.0 - [nodegit](https://npm.io/package/nodegit.md) ^0.14.1 - [nodepdf](https://npm.io/package/nodepdf.md) ^1.3.0 - [inquirer](https://npm.io/package/inquirer.md) ^1.1.2 - [jsonfile](https://npm.io/package/jsonfile.md) ^2.3.1 - [commander](https://npm.io/package/commander.md) ^2.9.0 - [pdfconcat](https://npm.io/package/pdfconcat.md) ^1.0.2 - [livereload](https://npm.io/package/livereload.md) ^0.5.0 - [prettyjson](https://npm.io/package/prettyjson.md) ^1.1.3 - [sprintf-js](https://npm.io/package/sprintf-js.md) ^1.0.3 - [body-parser](https://npm.io/package/body-parser.md) ^1.15.2 - [multispinner](https://npm.io/package/multispinner.md) ^0.2.1 - [command-exists](https://npm.io/package/command-exists.md) ^1.0.2 - [connect-inject](https://npm.io/package/connect-inject.md) ^0.4.0 ## Recent versions - 0.4.0 (latest) — 2016-08-16 - 0.3.4 — 2016-08-15 - 0.3.3 — 2016-08-15 - 0.3.2 — 2016-08-12 - 0.3.1 — 2016-08-12 - 0.2.0 — 2016-08-10 - 0.1.4 — 2016-08-08 - 0.1.3 — 2016-08-05 - 0.1.2 — 2016-08-05 - 0.1.0 — 2016-08-04 - 0.0.7 — 2016-08-04 - 0.0.6 — 2016-08-03 - 0.0.5 — 2016-08-03 - 0.0.3 — 2016-08-02 - 0.0.2 — 2016-08-01 - … 1 more at https://npm.io/package/sushi-tool/versions ## README ![Chopsticks logo](assets/logo-chopsticks.jpg) # chopsticks (sushi-tool) This tool has been designed to help you to create and maintain your sushi cards. With chopstick you can do the following tasks: * Init a sushi card project * Add sushi cards sheets to your project * Start a live mode to see the result of compiling your sushi cards. This live mode use the livereload feature, which refresh your browser automatically every time you save your markdown file. * Compile your sushi card markdown files into a set of pdfs or a single one. ## Install chopsticks ```bash npm install -g sushi-tool ``` ## Use chopsticks ```bash $ mkdir my-sushi-set $ cd !^ $ chopsticks init ``` ### Init command Initialize a folder to star creating a sushi card ```bash $ chopsticks init ``` ![Init command demo](assets/init-command.gif) ### Live command This mode allow you to edit your sushi cards and see the result in your every time you save your file without the need of refreshing it. ```bash $ chopsticks live ``` ![Live command demo](assets/live-command.gif) ### PDF command This command allow you to render your sushi cards in a set of pdfs or a single one. To generate a **set of pdfs** execute the following command in your project folder: ```bash $ chopsticks pdf output_folder ``` To generate a **single pdf** add the merge (-m) option. ```bash $ chopsticks pdf -m output.pdf ``` ![Live command demo](assets/pdf-merge-command.gif) ### Sync command If you create new markdown files, you can update your configuration file using the following command. ```bash $ chopsticks sync ``` ## Dependencies To use the pdf generation you need to have installed ```phantomjs```, install it using ```npm```: ```bash $ sudo npm install -g phantomjs ``` To merge your pdf filesthe ```pdfunite``` command line tool, which uses the `poppler` library. ### Linux Install the `poppler-utils` package using your package manager. ### OS X Install `poppler` using Homebrew. --- _Source: https://npm.io/package/sushi-tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._