@tokenring-ai/writer 0.1.6

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Mark Dierolf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,140 @@
+# TokenRing Writer (tr-writer)
+
+## Overview
+
+TokenRing Writer (tr-writer) is a unified platform for writing and managing news articles & blog posts. It provides a
+powerful interface where you can create, edit, and publish content, leveraging AI to assist with writing, editing,
+formatting, and publishing workflows.
+
+## Features
+
+- **Agent-based architecture**: Multiple specialized AI agents for different content creation tasks (writer, editor, researcher, publisher).
+- **Interactive chat interface**: Talk to agents in a conversational REPL for content creation assistance.
+- **Persistent content history**: Sessions and content drafts are saved in a SQLite database.
+- **Command system**: Issue commands prefixed with `/` to manage agents, content, and workflows.
+- **Publishing integration**: Works directly with your content directory; can initialize with a TokenRing config.
+- **Multi-model support**: Support for various AI models from different providers.
+- **Research capabilities**: Built-in web search and Wikipedia integration for content research.
+- **File system integration**: Direct integration with local and cloud file systems.
+
+## Getting Started
+
+### Prerequisites
+
+- Bun
+- Git initialized content directory
+
+### Installation (local)
+
+1. **Sync git submodules**: This project uses git submodules that need to be initialized and updated before
+   installation:
+   ```bash
+   git submodule update --init --recursive
+   ```
+
+2. **Install dependencies**: This project uses Bun as the package manager in a monorepo structure:
+   ```bash
+   bun install
+   ```
+
+3. **Run the application**: Use Bun to start the application:
+
+  ```bash
+  bun src/tr-writer.ts --source ./path-to-your-content
+  ```
+
+### Installation (As local docker container)
+
+1. **Sync git submodules**: This project uses git submodules that need to be initialized and updated before
+   installation:
+   ```bash
+   git submodule update --init --recursive
+   ```
+
+2. **Build the docker container**:
+   ```bash
+   # This command must be run in the root directory of the repo
+   docker build -t token-ring/writer:latest -f docker/Dockerfile .
+   ```
+
+3. **Run the docker container**:
+   ```bash
+   docker run -ti --net host $(env | grep '_KEY' | sed 's/^/-e /') -v ./:/repo:rw token-ring/writer:latest
+   ```
+
+#### Container Registry
+
+TODO: This is not implemented yet
+The Docker image is automatically built and published to GitHub Container Registry on each push to the main branch. You
+can pull the latest image with:
+
+```bash
+docker pull ghcr.io/[owner]/tokenring-writer:latest
+```
+
+Replace `[owner]` with the GitHub repository owner.
+
+### Initialization
+
+To initialize your content directory with the necessary TokenRing configuration file, pass the --initialize flag after
+your content directory.
+This will initialize a new .tokenring directory in your project, which stores a writer-config.js config file for your
+project that you can customize, as well as a sqlite database which stores your content history.
+
+```
+tr-writer --source ./path-to-your-content --initialize
+```
+
+This copies a default `.tokenring/writer-config.js` into your content directory.
+
+### Chat and Commands
+
+Once started, you enter the agent chat REPL:
+
+- Type natural language queries to interact with AI agents for content creation.
+- Use commands with `/` prefix, e.g., `/help`, `/agent switch writer`, `/tools enable`.
+- Switch between different agents specialized for writing, editing, research, and publishing.
+- Control commands: `/quit` to exit, `/agent list` to see available agents.
+
+### Commands
+
+Some example commands:
+
+- `/help`: Show available commands.
+- `/agent list`: List available agents.
+- `/agent switch <name>`: Switch to a specific agent.
+- `/tools list`: Show available tools.
+- `/tools enable <pattern>`: Enable specific tools.
+
+## Architecture
+
+- **CLI**: Entry point with argument parsing and agent team initialization (`tr-writer.ts`).
+- **Agents**: Specialized AI agents for different content creation tasks (writer, editor, researcher, publisher).
+- **Services**: Core services for file system, web search, models, and database management.
+- **Configuration**: Flexible configuration system supporting multiple models and services.
+
+## Data Persistence
+
+Content data and sessions are stored in a SQLite database (`writer-database.sqlite`) managed through the Bun SQLite
+package.
+
+## Extensibility
+
+The system supports:
+- **Custom agents**: Define new agents with specific roles and capabilities.
+- **Multiple AI models**: Support for various providers (OpenAI, Anthropic, Google, etc.).
+- **Service providers**: Pluggable services for file systems, web search, and content publishing.
+- **Tool integration**: Extensible tool system for agent capabilities.
+
+## Contributing
+
+Contributions are welcome! Feel free to fork the repository and submit pull requests.
+
+## License
+
+This project is MIT licensed
+
+---
+
+This README provides a high-level overview of the TokenRing Writer (tr-writer) functionality and usage. For detailed
+command usage, use `/help` inside the chat REPL.

package/package.json

@@ -0,0 +1,64 @@
+{
+ "name": "@tokenring-ai/writer",
+ "description": "TokenRing Writer Application",
+ "version": "0.1.6",
+ "dependencies": {
+  "@dotenvx/dotenvx": "^1.48.4",
+  "@inquirer/prompts": "^7.8.1",
+  "@tokenring-ai/ai-client": "0.1.0",
+  "@tokenring-ai/blog": "0.1.0",
+  "@tokenring-ai/agent": "0.1.0",
+  "@tokenring-ai/chrome": "0.1.0",
+  "@tokenring-ai/checkpoint": "0.1.0",
+  "@tokenring-ai/cli": "0.1.0",
+  "@tokenring-ai/cloudquote": "0.1.0",
+  "@tokenring-ai/feedback": "0.1.0",
+  "@tokenring-ai/ghost-io": "0.1.0",
+  "@tokenring-ai/local-filesystem": "0.1.0",
+  "@tokenring-ai/mcp": "0.1.0",
+  "@tokenring-ai/memory": "0.1.0",
+  "@tokenring-ai/queue": "0.1.0",
+  "@tokenring-ai/tasks": "0.1.0",
+  "@tokenring-ai/reddit": "0.1.0",
+  "@tokenring-ai/s3": "0.1.0",
+  "@tokenring-ai/scripting": "0.1.0",
+  "@tokenring-ai/sqlite-storage": "0.1.0",
+  "@tokenring-ai/template": "0.1.0",
+  "@tokenring-ai/wikipedia": "0.1.0",
+  "commander": "^14.0.0",
+  "path-browserify": "^1.0.1"
+ },
+ "devDependencies": {
+  "@biomejs/biome": "^2.2.0",
+  "husky": "^9.1.7",
+  "jsdom": "^26.1.0",
+  "node-gyp": "^11.3.0",
+  "trufflehog": "^0.0.5",
+  "ts": "^0.2.2",
+  "vitest": "^3.2.4"
+ },
+ "license": "MIT",
+ "bin": {
+  "tr-writer": "./dist/tr-writer"
+ },
+ "files": [
+  "dist",
+  "LICENSE",
+  "README.md"
+ ],
+ "scripts": {
+  "build": "bun build --compile --outfile=dist/tr-writer src/tr-writer.ts",
+  "prepublishOnly": "bun run build",
+  "build-container": "docker build -t tokenring-ai/coder:latest -f docker/Dockerfile .",
+  "coder": "bun ../tokenring-coder/src/tr-coder.js --source ./",
+  "test": "vitest run",
+  "prepare": "husky",
+  "biome": "biome format --fix",
+  "update-all-dependencies-latest": "git submodule foreach npx npm-check-updates -u",
+  "release:patch": "NEWVERSION=`bun pm version patch` && git add package.json && git commit -m \"Bump version to ${NEWVERSION}\" && git tag ${NEWVERSION} && git submodule foreach git push && git push && git push --tags"
+ },
+ "type": "module",
+ "workspaces": [
+  "pkg/*"
+ ]
+}