@r3ply/cli 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +661 -0
- package/README.md +66 -0
- package/dist/comments-markov-model.json +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.mjs +2007 -0
- package/package.json +73 -0
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# r3ply CLI
|
|
2
|
+
|
|
3
|
+
CLI tool to help websites integrate with the r3ply commenting system.
|
|
4
|
+
|
|
5
|
+
The r3ply commenting system allows websites to receive comments via email. It works well with static sites as well as dynamic sites. This package helps you do things like simulate emails so you can focus on templating them the way you want, without requiring you to manually send comments yourself over email. Essentially it allows for quick and accurate iteration, and makes the final deployment much more smooth.
|
|
6
|
+
|
|
7
|
+
> See [r3ply.com](https://r3ply.com) for more information, or read the [docs](https://r3ply.com/docs/cli/)
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
Install `@r3ply/cli` from npm.
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
# npm
|
|
15
|
+
npm install --save-dev @r3ply/cli
|
|
16
|
+
# pnpm
|
|
17
|
+
pnpm install --dev @r3ply/cli
|
|
18
|
+
# bun
|
|
19
|
+
bun install --dev @r3ply/cli
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
Usage: re [options] [command]
|
|
26
|
+
|
|
27
|
+
CLI for r3ply
|
|
28
|
+
|
|
29
|
+
Options:
|
|
30
|
+
-V, --version output the version number
|
|
31
|
+
--config <path> specify path to config
|
|
32
|
+
--format <toml | json> format to use with file output (default: "toml")
|
|
33
|
+
-h, --help display help for command
|
|
34
|
+
|
|
35
|
+
Commands:
|
|
36
|
+
init [options] initialize a new r3ply project (at current directory)
|
|
37
|
+
config r3ply config commands
|
|
38
|
+
generate generate useful text
|
|
39
|
+
simulate simulate receiving a comment using your r3ply config
|
|
40
|
+
cache manage comment cache
|
|
41
|
+
help [command] display help for command
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
More detailed information is at [r3ply.com/docs/cli](https://r3ply.com/docs/cli/).
|
|
45
|
+
|
|
46
|
+
## Development
|
|
47
|
+
|
|
48
|
+
You can build once or continuously.
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
# build once
|
|
52
|
+
pnpm build
|
|
53
|
+
# build continuously (use `pnpm link` to be able to test the changes)
|
|
54
|
+
pnpm build:watch
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Text generation for simulation of comments happens under [`src/comment_generation`](./src/comment_generation/).
|
|
58
|
+
|
|
59
|
+
To build the markov chain for text generation you need to run the `pretrain` and `train` steps.
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
# prepares and preprocesses the training data
|
|
63
|
+
pnpm pretrain
|
|
64
|
+
# adds the data to the markov chain
|
|
65
|
+
pnpm train
|
|
66
|
+
```
|