writer

package
v0.6.1007-dev.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2026 License: MIT, MIT Imports: 2 Imported by: 0

README

The Voice Writer

The Voice Writer is the QuickAgent that writes a person's Writing Voice. You give it samples of your own writing, and it writes VOICE.md: the instructions an LLM follows to write the way you do. With a voice attached, a QuickAgent run writes its answers, reports and messages in it. Run it again with more samples and a brief to improve the voice, or with a note (and, if you like, more samples) to edit it.

This is the package that runs

The Voice Writer is built into the Agentry CLI and the desktop app, and it runs from there: on your computer when you run agentry voice create, improve or edit (or make a voice in the desktop), and on an Agentry sandbox host when you make one in Agentry. This release has the same bytes. The registry built its archive from the package the CLI carries, and the archive's digest is the one the CLI reports. Run agentry builtins to print it and compare it with the digest on this page.

Installing this release does not give you the Voice Writer. The application runs it as a built-in, with the steps and tools listed below. If you install this release, it runs as an ordinary QuickAgent with only what its manifest declares.

What the application does around it

The manifest declares no network access, no file access and no commands, and one data category, files. When Agentry writes a voice:

  • Before the run, the runner decodes each sample to text: a PDF, an office file or an image becomes a .txt file, and a text file stays as it is. The Voice Writer runs no decoder itself. It reads the text, and the current voice when there is one, through the inputs channel (list_inputs, read_input).
  • Pages from web addresses, when you give some on your computer, are fetched before the run by the step a run's input source takes: in the files container, on a network of its own behind a proxy to that host alone. AI Review reads each page's text, with your own TypeSafe key, before the Voice Writer does, and a page it flags or cannot scan is withheld and named. A page whose text is drawn by scripts is read during the run with web_read, which the application grants for that run alone: it opens only the addresses you gave, renders the page in a headless Chromium the application runs once a page, on a network whose one way out admits public sites alone, and has AI Review read the rendered text first. The model never drives that browser and has no web_search.
  • Its guide. The release ships a knowledge pack, knowledge/style-guide: the dimensions of a voice, reading a web page, a worked example, and the questions AI Review asks of a voice. The application attaches it to every run.
  • During the run, it writes VOICE.md with write_report. Like every run, it has a scratch folder for its notes, private to the run and deleted with it, and grep and glob to search the samples and that folder.
  • After the run, the application checks the file's form (UTF-8 text, at most 32 KiB), not what it says, and keeps it as the voice. A voice made on your computer stays there and is not reviewed. A voice that reaches your Agentry account is reviewed before it is used there, to check that it holds only writing instructions.

INSTRUCTION.md is the instruction the model follows. It covers what a voice says, what it never says, and how the samples are read.

Documentation

Overview

Package writer is the Voice Writer: the QuickAgent package that writes a person's Writing Voice from samples of their writing, embedded in the CLI and run by the runner as a built-in package, the third beside the Knowledge Creator and the Drafter. Its contract declares no egress, no filesystem, no exec and the files data category: the runner decodes the samples before the run (pkg/runner/decode), the agent reads their text and the current voice through the inputs channel, and writes VOICE.md through write_report; pkg/voice/build keeps it. A build may give it web addresses of the person's writing: a page whose text was read before the run arrives as a sample, and one drawn by scripts is read with web_read, which the application grants it held to those addresses alone (pkg/runner/localrun).

Index

Constants

View Source
const (
	Namespace = "agentry"
	Name      = "voice-writer"
	Version   = "1.3.0"
)

The package's identity, as its manifest declares it.

View Source
const GuideName = "style-guide"

GuideName is the knowledge pack the Voice Writer ships in its own release, its guide to writing a voice: the dimensions of a voice, reading a web page, a worked example, and what AI Review refuses in a voice. The runner gives it to every run of the package (localrun's withShippedPacks). Its manifest.json, index and review page are generated (TestTheStyleGuideIsCurrent).

View Source
const LocalTimeoutFloorSeconds = 1800

LocalTimeoutFloorSeconds is the least a Voice Writer run on this computer is given: 30 minutes, past the runner policy's 15-minute run timeout, since reading a person's samples outruns an ordinary task. It is a timeout alone, as the Knowledge Creator's floor is.

Variables

This section is empty.

Functions

func FS

func FS() fs.FS

FS is the package's tree: agent.yaml, INSTRUCTION.md, README.md and LICENSE at its root (a public release carries the last two), and under knowledge/ the pack it ships (GuideName).

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL