https://github.com/gunmer/pdf-card-generator
https://github.com/gunmer/pdf-card-generator
card-generator cards cli console console-application oclif pdf-generation terminal
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gunmer/pdf-card-generator
- Owner: Gunmer
- Created: 2019-09-20T21:59:54.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-22T19:23:18.000Z (over 6 years ago)
- Last Synced: 2025-06-10T09:44:31.374Z (about 1 year ago)
- Topics: card-generator, cards, cli, console, console-application, oclif, pdf-generation, terminal
- Language: HTML
- Size: 316 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pdf-card-generator
[](https://oclif.io)
[](https://npmjs.org/package/pdf-card-generator)
[](https://npmjs.org/package/pdf-card-generator)
[](https://github.com/Gunmer/pdf-card-generator/blob/master/package.json)
It generates cards for scrum or kanban from a csv file and a mustache template.
As a result, it generates a json with the data extracted from the csv, an htm file and finally the resulting pdf.
* [Install](##Install)
* [Version](##Version)
* [pdf-card-generator](#pdf-card-generator)
* [Usage](#usage)
* [Commands](#commands)
## Install
It is necessary to have [NodeJS](https://nodejs.org/es/) installed
```shell script
$ npm install -g pdf-card-generator
$ cardGen COMMAND
running command...
```
## Version
```shell script
$ cardGen (-v|--version|version)
pdf-card-generator/1.0.2 darwin-x64 node-v12.7.0
```
# Usage
```sh-session
$ npm install -g pdf-card-generator
$ cardGen COMMAND
running command...
$ cardGen (-v|--version|version)
pdf-card-generator/2.2.0 darwin-x64 node-v12.7.0
$ cardGen --help [COMMAND]
USAGE
$ cardGen COMMAND
...
```
# Commands
* [`cardGen generate [WORKDIR]`](#cardgen-generate-workdir)
* [`cardGen help [COMMAND]`](#cardgen-help-command)
* [`cardGen initialize [WORKDIR]`](#cardgen-initialize-workdir)
## `cardGen generate [WORKDIR]`
generate a pdf file to print
```
USAGE
$ cardGen generate [WORKDIR]
OPTIONS
-h, --help show CLI help
ALIASES
$ cardGen g
$ cardGen gen
```
_See code: [src/commands/generate.ts](https://github.com/Gunmer/pdf-card-generator/blob/v2.2.0/src/commands/generate.ts)_
## `cardGen help [COMMAND]`
display help for cardGen
```
USAGE
$ cardGen help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.1/src/commands/help.ts)_
## `cardGen initialize [WORKDIR]`
create config file and copy resources
```
USAGE
$ cardGen initialize [WORKDIR]
OPTIONS
-h, --help show CLI help
ALIASES
$ cardGen i
$ cardGen init
```
_See code: [src/commands/initialize.ts](https://github.com/Gunmer/pdf-card-generator/blob/v2.2.0/src/commands/initialize.ts)_