@tokenring-ai/writer 0.1.7 → 0.1.9
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/README.md +32 -8
- package/dist/tr-writer +0 -0
- package/package.json +20 -11
package/README.md
CHANGED
|
@@ -17,14 +17,38 @@ formatting, and publishing workflows.
|
|
|
17
17
|
- **Research capabilities**: Built-in web search and Wikipedia integration for content research.
|
|
18
18
|
- **File system integration**: Direct integration with local and cloud file systems.
|
|
19
19
|
|
|
20
|
+
## Available Agents
|
|
21
|
+
|
|
22
|
+
TokenRing Writer includes specialized AI agents for different content creation workflows:
|
|
23
|
+
|
|
24
|
+
- **Content Writer**: Expert content writer specializing in creating engaging, well-structured articles and blog posts. Excels at research, storytelling, and adapting writing style to different audiences.
|
|
25
|
+
- **Managing Editor**: Coordinates content creation by searching for trending news topics, evaluating newsworthiness, creating article assignments, and dispatching tasks to specialized writing agents.
|
|
26
|
+
|
|
20
27
|
## Getting Started
|
|
21
28
|
|
|
29
|
+
### Quick Start (NPM)
|
|
30
|
+
|
|
31
|
+
Run directly using npx without installation:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
npx @tokenring-ai/writer --source ./path-to-your-content --initialize
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Quick Start (Docker)
|
|
38
|
+
|
|
39
|
+
Pull and run from GitHub Container Registry:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
docker pull ghcr.io/tokenring-ai/writer:latest
|
|
43
|
+
docker run -ti --net host $(env | grep '_KEY' | sed 's/^/-e /') -v ./path-to-your-content:/repo:rw ghcr.io/tokenring-ai/writer:latest
|
|
44
|
+
```
|
|
45
|
+
|
|
22
46
|
### Prerequisites
|
|
23
47
|
|
|
24
|
-
- Bun
|
|
48
|
+
- Bun (for local development)
|
|
25
49
|
- Git initialized content directory
|
|
26
50
|
|
|
27
|
-
### Installation (local)
|
|
51
|
+
### Installation (local development)
|
|
28
52
|
|
|
29
53
|
1. **Sync git submodules**: This project uses git submodules that need to be initialized and updated before
|
|
30
54
|
installation:
|
|
@@ -64,16 +88,16 @@ formatting, and publishing workflows.
|
|
|
64
88
|
|
|
65
89
|
#### Container Registry
|
|
66
90
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
91
|
+
The Docker image is automatically built and published to GitHub Container Registry on version tags. Available tags:
|
|
92
|
+
|
|
93
|
+
- `latest`: Latest stable release
|
|
94
|
+
- `v*.*.*`: Specific version tags
|
|
95
|
+
- `main`: Latest build from main branch
|
|
70
96
|
|
|
71
97
|
```bash
|
|
72
|
-
docker pull ghcr.io/
|
|
98
|
+
docker pull ghcr.io/tokenring-ai/writer:latest
|
|
73
99
|
```
|
|
74
100
|
|
|
75
|
-
Replace `[owner]` with the GitHub repository owner.
|
|
76
|
-
|
|
77
101
|
### Initialization
|
|
78
102
|
|
|
79
103
|
To initialize your content directory with the necessary TokenRing configuration file, pass the --initialize flag after
|
package/dist/tr-writer
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tokenring-ai/writer",
|
|
3
3
|
"description": "TokenRing Writer Application",
|
|
4
|
-
"version": "0.1.
|
|
4
|
+
"version": "0.1.9",
|
|
5
5
|
"devDependencies": {
|
|
6
|
-
"@
|
|
7
|
-
"@inquirer/prompts": "^7.
|
|
6
|
+
"@biomejs/biome": "^2.3.1",
|
|
7
|
+
"@inquirer/prompts": "^7.9.0",
|
|
8
8
|
"@tokenring-ai/ai-client": "workspace:*",
|
|
9
9
|
"@tokenring-ai/blog": "workspace:*",
|
|
10
10
|
"@tokenring-ai/agent": "workspace:*",
|
|
@@ -12,6 +12,14 @@
|
|
|
12
12
|
"@tokenring-ai/checkpoint": "workspace:*",
|
|
13
13
|
"@tokenring-ai/cli": "workspace:*",
|
|
14
14
|
"@tokenring-ai/cloudquote": "workspace:*",
|
|
15
|
+
"@tokenring-ai/cdn": "workspace:*",
|
|
16
|
+
"@tokenring-ai/serper": "workspace:*",
|
|
17
|
+
"@tokenring-ai/research": "workspace:*",
|
|
18
|
+
"@tokenring-ai/scraperapi": "workspace:*",
|
|
19
|
+
"@tokenring-ai/websearch": "workspace:*",
|
|
20
|
+
"@tokenring-ai/wordpress": "workspace:*",
|
|
21
|
+
"@tokenring-ai/drizzle-storage": "workspace:*",
|
|
22
|
+
"@tokenring-ai/filesystem": "workspace:*",
|
|
15
23
|
"@tokenring-ai/feedback": "workspace:*",
|
|
16
24
|
"@tokenring-ai/ghost-io": "workspace:*",
|
|
17
25
|
"@tokenring-ai/local-filesystem": "workspace:*",
|
|
@@ -22,18 +30,20 @@
|
|
|
22
30
|
"@tokenring-ai/reddit": "workspace:*",
|
|
23
31
|
"@tokenring-ai/s3": "workspace:*",
|
|
24
32
|
"@tokenring-ai/scripting": "workspace:*",
|
|
25
|
-
"@tokenring-ai/sqlite-storage": "workspace:*",
|
|
26
33
|
"@tokenring-ai/template": "workspace:*",
|
|
27
34
|
"@tokenring-ai/wikipedia": "workspace:*",
|
|
28
|
-
"
|
|
29
|
-
"
|
|
30
|
-
"
|
|
35
|
+
"@types/bun": "^1.3.1",
|
|
36
|
+
"bun-types": "^1.3.1",
|
|
37
|
+
"chalk": "^5.6.2",
|
|
38
|
+
"commander": "^14.0.2",
|
|
31
39
|
"husky": "^9.1.7",
|
|
32
40
|
"jsdom": "^26.1.0",
|
|
33
|
-
"node-gyp": "^11.
|
|
41
|
+
"node-gyp": "^11.5.0",
|
|
34
42
|
"trufflehog": "^0.0.5",
|
|
35
43
|
"ts": "^0.2.2",
|
|
36
|
-
"
|
|
44
|
+
"typescript": "^5.9.3",
|
|
45
|
+
"vitest": "^3.2.4",
|
|
46
|
+
"zod": "^4.1.12"
|
|
37
47
|
},
|
|
38
48
|
"license": "MIT",
|
|
39
49
|
"bin": {
|
|
@@ -47,8 +57,7 @@
|
|
|
47
57
|
"scripts": {
|
|
48
58
|
"build": "bun build --compile --outfile=dist/tr-writer src/tr-writer.ts",
|
|
49
59
|
"prepublishOnly": "bun run build",
|
|
50
|
-
"
|
|
51
|
-
"coder": "bun ../tokenring-coder/src/tr-coder.js --source ./",
|
|
60
|
+
"writer": "bun src/tr-writer.js --source ./",
|
|
52
61
|
"test": "vitest run",
|
|
53
62
|
"prepare": "husky",
|
|
54
63
|
"biome": "biome format --fix",
|