From bb79711ff593cca64d281a1e4be20e04e0e60092 Mon Sep 17 00:00:00 2001
From: Genta Kamitani <oftn.mofumofu@gmail.com>
Date: Mon, 28 Dec 2020 22:29:21 +0900
Subject: [PATCH] :books: doc: add description of command line tool

---
 README.md  |  2 +-
 doc/cli.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 1 deletion(-)
 create mode 100644 doc/cli.md

diff --git a/README.md b/README.md
index 51c869a..b4aff24 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ Watson makes it hard but fun to write configuration files.
 
 ## Index
 * [Language Specification](./doc/spec.md)
-* [CLI Tool(WIP)](#)
+* [CLI Tool](./doc/cli.md)
 * [pkg.go.dev](https://pkg.go.dev/github.com/genkami/watson)
 
 ## Installation
diff --git a/doc/cli.md b/doc/cli.md
new file mode 100644
index 0000000..ad53572
--- /dev/null
+++ b/doc/cli.md
@@ -0,0 +1,48 @@
+# CLI Tool
+
+All subcommands:
+
+* [watson encode](#watson-encode)
+* [watson decode](#watson-decode)
+
+## watson encode
+
+### Usage
+
+```
+watson encode -t=TYPE [-initial-mode=MODE] [FILE]
+```
+
+Converts `FILE` of type `TYPE` into Watson and outputs its Watson Representation to the standard output.
+
+If `FILE` is not specified, it uses the standard input.
+
+### Flags
+
+| flag | mandatory | type | default | description |
+| ---- | --------- | ---- | ------- | ----------- |
+| **-t**    | no        | `json`, `yaml`, `msgpack`, or `cbor` | `yaml` | input file format |
+| **-initial-mode** | no | `A` or `S` | `A` | initial mode of the lexer. see [the specification](./spec.md) for more details. |
+
+## watson decode
+
+
+### Usage
+
+```
+watson decode -t=TYPE [-initial-mode=MODE] [-stack-size=SIZE] [FILES...]
+```
+
+Converts Watson files `FILES` into another format that is specified by `TYPE` and outputs it to the standard output.
+
+If `FILES` is not specified, it uses the standard input.
+
+If multiple files are specified, they are executed sequencially by the same lexer and VM, that is, the mode of the lexer and the stack of the VM remains unchanged when the VM finished processing one file and continues to another. After processing the last file, a value at the top of the VM's stack is displayed.
+
+### Flags
+
+| flag | mandatory | type | default | description |
+| ---- | --------- | ---- | ------- | ----------- |
+| **-t**    | no        | `json`, `yaml`, `msgpack`, or `cbor` | `yaml` | input file format |
+| **-initial-mode** | no | `A` or `S` | `A` | initial mode of the lexer. see [the specification](./spec.md) for more details. |
+| **-stack-size** | no | integer | 1024 | stack size of the VM. see [the specification](./spec.md) for more details. |