allanvobraun / dontpad-cli

A command line interface for use dontpad.com

Dontpad CLI

A command line interface for dontpad.com

Table of Contents

• Table of Contents
• About The Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• License
• Contact
• Special thanks

About The Project

Dontpad CLI is a command line interface for writing and sharing notes direct from your console.

Getting Started

To get yourself Dontpad CLI, follow these simple steps.

Prerequisites

NodeJS and npm are required to install Dontpad CLI.
You download node and npm here.

After installation run:

npm install npm@latest -g

For update npm.

Installation

1. Install the package

npm install --global dontpad-cli

2. Check the installation

dontpad --version

You should see the version on console.

Usage

---

To read all the commands and options simple run:

dontpad --help

Commands:

Command	Description	Usage
	Empty command, append text to a repository	dontpad 'text' [args]
get	Read information from a repository and prints on terminal	dontpad get [args]

---

General options:

Option	Description	Default
--help	Show help	None
--version	Show version	None
-r or --repository	Specify the dontpad repository	System user name
-s or --separator	Specify a string separator between appends	\n
-o or --overwrite	Overwrite all content in the repository	false
-c or --copy	Copy the last line from the repository to the clipboard (only disponible with get command)	false

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Allan Braun - [email protected]

Project Link: https://github.com/allanvobraun/dontpad-CLI

NPM Link: https://www.npmjs.com/package/dontpad-cli

Special thanks

• Mum
• Matheus Bertho for features ideas
• Willian Ferreira for js help