# wand-cli

> Node.js CLI memo tool

Latest version **0.4.3** (published 2021-06-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install wand-cli
pnpm add wand-cli
yarn add wand-cli
bun add wand-cli
```

Provides the command `wand`.

## 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.3 |
| Published | 2021-06-07 |
| First published | 2021-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | kazuhe |
| Maintainers | kazuhe |
| Keywords | wand, wand-cli |

## Links

- npm: https://www.npmjs.com/package/wand-cli
- Repository: https://github.com/kazuhe/wand-cli
- Homepage: https://github.com/kazuhe/wand-cli#readme
- Issues: https://github.com/kazuhe/wand-cli/issues
- npm.io page: https://npm.io/package/wand-cli

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [marked](https://npm.io/package/marked.md) ^2.0.3
- [nanoid](https://npm.io/package/nanoid.md) ^3.1.23

## Recent versions

- 0.4.3 (latest) — 2021-06-07
- 0.4.2 — 2021-06-06
- 0.4.1 — 2021-05-30
- 0.4.0 — 2021-05-25
- 0.3.0 — 2021-05-25
- 0.2.0 — 2021-05-17
- 0.1.0 — 2021-05-12

## README

<br>

<p align="center">
<b>Wand CLI is Node.js CLI memo tool 🧙✨</b> 
</p>

<p align="center">
<a href="https://www.npmjs.com/package/wand-cli"><img src="https://img.shields.io/npm/v/wand-cli.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/package/wand-cli"><img src="https://img.shields.io/npm/l/wand-cli.svg" alt="Package License" /></a>
</p>

<br>

# wand-cli
Node.js CLI memo tool

## Usage

### Installation
`npx`でWand CLIを実行するために`-g`オプションを使用してライブラリをグローバルにインストールします。
```bash
$ npm i -g wand-cli
```

### Basic workflow
インストールが完了すると`wand`コマンドを呼び出すことができます。
次のように入力して使用可能なコマンドを確認してください。
```bash
$ npx wand --help
```

まずは初期設定でメモを管理するためのリモートリポジトリのURLを登録します。  
下記コマンドを実行すると、対話形式でURLを求められるので入力してください。内部的には`git clone`を行っており、成功するとユーザーのホームディレクトリ直下に`/wand`ディレクトリが作成されます。
```bash
$ npx wand init
```

初期設定が完了したら下記のコマンドで新しいメモを作成してみましょう。  
対話形式でメモのファイル名を聞かれます。特に指定がない場合はエンターを押してください。ランダムな文字列の`.md`ファイルが作成されます。
```bash
$ npx wand new
```

## Commadns
```
COMMANDS:
  wand init         Set up the repository and start Wand CLI.
  wand new          Create a new memo.
  wand list         Show the memo list.
  wand save         Save your changes and apply them to the remote repository.
  wand --help, -h   Show help.
```

## Prerequisites
⚠️ 前提として、gitコマンドそのものが利用できる環境である必要があります。  

## License
MIT License © 2021 [kazuhe](https://github.com/kazuhe)

---
_Source: https://npm.io/package/wand-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._