README
¶
bytheway
A Go CLI to capture and investigate fast inbounds — Slack threads, hallway asks, leadership questions — and turn them into entrypoints for agentic work in Claude Code.
Install
From script
curl -fsSL https://jvcorredor.github.io/bytheway/install.sh | sh
From source
go install github.com/jvcorredor/bytheway@latest
The binary lands in $HOME/.local/bin (or $GOBIN for go install) as btw. See the install reference for env-var overrides and $PATH setup.
Documentation
Full docs: https://jvcorredor.github.io/bytheway/. The docs site is the canonical reference for subcommands, flags, JSON schema, file format, config keys, and agentic-usage patterns.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd assembles the btw cobra command tree.
|
Package cmd assembles the btw cobra command tree. |
|
internal
|
|
|
config
Package config loads and validates the user's btw configuration.
|
Package config loads and validates the user's btw configuration. |
|
id
Package id mints the short hexadecimal identifiers used to name task files.
|
Package id mints the short hexadecimal identifiers used to name task files. |
|
render
Package render formats tasks for human and JSON output.
|
Package render formats tasks for human and JSON output. |
|
research
Package research is the top-level orchestration layer for headless research runs.
|
Package research is the top-level orchestration layer for headless research runs. |
|
research/log
Package log computes filesystem paths for research run log files under the btw tasks directory.
|
Package log computes filesystem paths for research run log files under the btw tasks directory. |
|
research/pool
Package pool runs research tasks in bounded parallel, emits streaming progress events as they execute, and aggregates a final batch Summary.
|
Package pool runs research tasks in bounded parallel, emits streaming progress events as they execute, and aggregates a final batch Summary. |
|
research/prompt
Package prompt loads and renders the research prompt template passed to the headless claude agent.
|
Package prompt loads and renders the research prompt template passed to the headless claude agent. |
|
research/runner
Package runner spawns the headless claude agent that performs research, tees its stream-json output to a log file, and parses the agent's final fenced JSON block into a typed Result.
|
Package runner spawns the headless claude agent that performs research, tees its stream-json output to a log file, and parses the agent's final fenced JSON block into a typed Result. |
|
research/writeback
Package writeback applies a research run's side effects: appends a timestamped Research section to the task body, sets the research-meta frontmatter on findings/clarify (not failed), and appends a worklog line.
|
Package writeback applies a research run's side effects: appends a timestamped Research section to the task body, sets the research-meta frontmatter on findings/clarify (not failed), and appends a worklog line. |
|
slug
Package slug derives the human-readable component of a task filename from a free-form description.
|
Package slug derives the human-readable component of a task filename from a free-form description. |
|
store
Package store is the on-disk task repository: it owns the layout under the configured tasks directory and is the only package that reads from or writes to it.
|
Package store is the on-disk task repository: it owns the layout under the configured tasks directory and is the only package that reads from or writes to it. |
|
tag
Package tag provides pure functions for normalising, validating, and deduplicating task tags.
|
Package tag provides pure functions for normalising, validating, and deduplicating task tags. |
|
task
Package task is the in-memory model and on-disk codec for a single task file.
|
Package task is the in-memory model and on-disk codec for a single task file. |
|
tty
Package tty wraps terminal-detection and width queries so the rest of the codebase does not depend on golang.org/x/term directly.
|
Package tty wraps terminal-detection and width queries so the rest of the codebase does not depend on golang.org/x/term directly. |
|
version
Package version reports the btw binary's build identity.
|
Package version reports the btw binary's build identity. |
|
Command btw-migrate is the one-shot migration tool that promotes the legacy WORKING.md working log into the per-task file layout under the configured tasks directory.
|
Command btw-migrate is the one-shot migration tool that promotes the legacy WORKING.md working log into the per-task file layout under the configured tasks directory. |
Click to show internal directories.
Click to hide internal directories.