Skip to content

USAGE.md

Latest commit

 

History

History
133 lines (93 loc) · 3.41 KB

USAGE.md

File metadata and controls

133 lines (93 loc) · 3.41 KB

ByeBrief User Guide

Overview

ByeBrief is an investigation canvas where you drag blocks onto a grid to build cases, analyses, and reports. Each block can hold evidence, notes, people, locations, or timeline events.

The Canvas

The main canvas is an infinite grid where you place investigation blocks:

  • Drag blocks from the left toolbar onto the canvas
  • Move blocks by dragging them to new positions
  • Connect blocks by dragging from one handle to another
  • Zoom with mouse wheel, pan with middle-click drag

Adding Blocks

  1. Click the + button in the left toolbar
  2. Select a block type from the menu:
    • Cause (red) - Root causes
    • Timeline (orange) - Dated events
    • Evidence (green) - Supporting facts
    • Person (purple) - Individuals
    • Location (teal) - Places
    • Law/Policy (blue) - Legal references
    • Note (yellow) - Annotations
    • Analysis (yellow) - Interpretations
    • Hypothesis (pink) - Theories
    • Conclusion (indigo) - Findings

Notes

Yellow note boxes appear on the right rail. Click the Notes toggle to show/hide them. Notes are inline-editable and can be moved to the canvas.

Right-Click Context Menu

Right-click on any node to access:

  • Add Note - Create a yellow note box
  • Add Block - Add new block near selection
  • Edit - Modify block content
  • AI Optimize - Get structure analysis
  • Cross-Examine - Analyze claims and evidence
  • Delete - Remove the block

AI Features

Prerequisites

  • Ollama must be running (ollama serve)
  • Configure model in Settings (gear icon → AI Model tab)

AI Optimize

Analyzes your investigation structure and suggests missing information.

Cross-Examine

Checks for contradictions between claims and evidence. Provides risk ratings.

Generate Draft

Creates a legal-grade report using IRAC method:

  • Issue - The legal question
  • Rule - Applicable law
  • Application - Facts applied to rule
  • Conclusion - The finding

Using AI Results

AI results appear in a blue panel. You can:

  • Apply - Accept suggestions into your nodes
  • Review Diff - See changes in accept/reject modal
  • Dismiss - Close without applying

Search (Opt-In)

Web search requires configuration:

  1. Open Settings → Search tab
  2. Enter API key (Brave Search or Tavily)
  3. Set max results and search depth
  4. Toggle search enabled

Search is opt-in - it only runs when you explicitly request it.

Export Flows

Export Formats

Format Extension Use Case
Markdown .md GitHub, Notion
Word .docx Legal filings
PDF .pdf Court submission
Plain Text .txt Quick sharing

Exporting

  1. Click the Export button in the bottom bar
  2. Select format from the modal
  3. File downloads automatically

Example Output

Generate Draft (IRAC Method):

EXECUTIVE SUMMARY
The evidence establishes that [conclusion].

ISSUE
Whether the defendant violated [statute]...

RULE
Under [legal reference], liability requires...

APPLICATION
The facts show that [analysis]...

CONCLUSION
Based on the foregoing, [finding].

Screenshots

(Screenshots would be added here in the actual release)

Main Canvas

Shows the grid with colored nodes and connecting edges.

Settings Panel

Four tabs: AI Model, Search, UI, Export.

AI Results Panel

Blue panel showing analysis with Apply button.