Command Reference

Complete CLI options and configuration

Commands

Usage: inform [COMMAND] [OPTIONS]

Commands:
  init              Initialize corpus configuration
  sync              Sync all sources or specific source
  status            Show corpus sync status
  help              Show help message

sync Command

Synchronize corpus sources

Syntax

inform sync [SOURCE_ID] [OPTIONS]

Options

Option	Description
`--all`	Sync all configured sources
`--mirror`	Mirror small artifacts to corpus_artifacts/
`--dry-run`	Print what would happen without executing
`--print-cmds`	Always print tool commands
`--no-manifest`	Run tools but do not write manifests
`--only`	Only allowed with sync: pull, index, export

corpus.yml Configuration

Define sources and sync behavior

Complete Example

# .fwdslsh/corpus/corpus.yml
version: "1.0"

sources:
  # HTTP source (web documentation)
  - id: official-docs
    type: http
    url: https://docs.example.com
    path: sources/official-docs/content
    index_path: sources/official-docs/catalog
    fetch: true

  # Git source (GitHub repository)
  - id: api-reference
    type: git
    url: https://github.com/owner/repo
    branch: main
    subpath: docs
    path: sources/api-reference/content
    index_path: sources/api-reference/catalog
    fetch: true

  # Local source (no fetching)
  - id: internal-docs
    type: local
    path: sources/internal-docs/content
    index_path: sources/internal-docs/catalog
    fetch: false

Source Types

Type	Fields
`http`	url, path, index_path, fetch (default: true)
`git`	url, branch, subpath, path, index_path, fetch (default: true)
`local`	path, index_path, fetch (default: false)

Timeout & Error Handling

Configure sync behavior for reliability

Environment Variables

Variable	Default	Description
`FWD_CORPUS_TIMEOUT`	`300000` (5 min)	Per-source timeout in milliseconds
`FWD_CORPUS_RETRIES`	`2`	Maximum retry attempts per source
`FWD_CORPUS_CONTINUE_ON_ERROR`	`true`	Continue syncing other sources if one fails

Error Logging

Sync errors are logged to ~/.hyphn/logs/inform-sync.log

# View recent sync errors
cat ~/.hyphn/logs/inform-sync.log | jq '.errors'

Git Workflow

Best practices for corpus management in Git

Git-Friendly Defaults

Configuration + manifests: Live under .fwdslsh/corpus/ (commit these)
Raw content: Lives under $FWDSLH_CORPUS_PATH/ (typically do NOT commit)
Optional mirroring: Mirror small artifacts to corpus_artifacts/ for PR review

.gitignore Example

# .fwdslsh/corpus/.gitignore
# Large raw content
sources/*/content/

# Optional build artifacts
sources/*/catalog/*.json
sources/*/catalog/*.db

# Cached data
.cache/