docs(logging): add note to logging customization section regarding existing logs
Generate documentation / build-docs (push) Has been cancelled
Generate documentation / build-docs (push) Has been cancelled
This commit is contained in:
+6
-2
@@ -39,8 +39,8 @@ A production-grade Fish shell configuration targeting Fish 4.x. It provides:
|
|||||||
- AI scaffolding helpers for Claude Code and Antigravity
|
- AI scaffolding helpers for Claude Code and Antigravity
|
||||||
- Catppuccin Mocha color theme throughout
|
- Catppuccin Mocha color theme throughout
|
||||||
|
|
||||||
CAUTION: **SESSION LOGGING IS OPT-IN**
|
CAUTION: **SESSION LOGGING**
|
||||||
Once enabled, this configuration *can* silently record terminal output to
|
If enabled, this configuration can silently record terminal output to
|
||||||
`~/.terminal_history`: Kitty scrollback on window close, live tmux pane
|
`~/.terminal_history`: Kitty scrollback on window close, live tmux pane
|
||||||
streams, zellij pane snapshots on exit, and full paru/yay output. These logs
|
streams, zellij pane snapshots on exit, and full paru/yay output. These logs
|
||||||
can contain command output, file contents, and secrets printed to the
|
can contain command output, file contents, and secrets printed to the
|
||||||
@@ -2806,6 +2806,10 @@ it is off, all capture is skipped and the logging wrappers are removed.
|
|||||||
~/.terminal_history/yay_YYYY-MM-DD_HH-MM-SS.log
|
~/.terminal_history/yay_YYYY-MM-DD_HH-MM-SS.log
|
||||||
Kitty watcher watcher.py captures scrollback when Kitty closes
|
Kitty watcher watcher.py captures scrollback when Kitty closes
|
||||||
|
|
||||||
|
NOTE: **Turning off logging does not delete any existing logs.**
|
||||||
|
They remain in `$SCROLLBACK_HISTORY_DIR` (defaults to: `~/.terminal_history/`)
|
||||||
|
until you remove them manually.
|
||||||
|
|
||||||
The tmux capture starts automatically when fish launches inside any tmux
|
The tmux capture starts automatically when fish launches inside any tmux
|
||||||
pane ($TMUX is set). It uses tmux's native pipe-pane to stream all pane
|
pane ($TMUX is set). It uses tmux's native pipe-pane to stream all pane
|
||||||
output directly to disk without an intermediate process. Each fish shell
|
output directly to disk without an intermediate process. Each fish shell
|
||||||
|
|||||||
@@ -301,6 +301,10 @@ it is off, all capture is skipped and the logging wrappers are removed.
|
|||||||
~/.terminal_history/yay_YYYY-MM-DD_HH-MM-SS.log
|
~/.terminal_history/yay_YYYY-MM-DD_HH-MM-SS.log
|
||||||
Kitty watcher watcher.py captures scrollback when Kitty closes
|
Kitty watcher watcher.py captures scrollback when Kitty closes
|
||||||
|
|
||||||
|
NOTE: **Turning off logging does not delete any existing logs.**
|
||||||
|
They remain in `$SCROLLBACK_HISTORY_DIR` (defaults to: `~/.terminal_history/`)
|
||||||
|
until you remove them manually.
|
||||||
|
|
||||||
The tmux capture starts automatically when fish launches inside any tmux
|
The tmux capture starts automatically when fish launches inside any tmux
|
||||||
pane ($TMUX is set). It uses tmux's native pipe-pane to stream all pane
|
pane ($TMUX is set). It uses tmux's native pipe-pane to stream all pane
|
||||||
output directly to disk without an intermediate process. Each fish shell
|
output directly to disk without an intermediate process. Each fish shell
|
||||||
|
|||||||
@@ -27,8 +27,8 @@ A production-grade Fish shell configuration targeting Fish 4.x. It provides:
|
|||||||
<LinkButton href="/09-installation/">Install now</LinkButton>
|
<LinkButton href="/09-installation/">Install now</LinkButton>
|
||||||
<LinkButton href="/reference/" variant="secondary">Function reference</LinkButton>
|
<LinkButton href="/reference/" variant="secondary">Function reference</LinkButton>
|
||||||
|
|
||||||
CAUTION: **SESSION LOGGING IS OPT-IN**
|
CAUTION: **SESSION LOGGING**
|
||||||
Once enabled, this configuration *can* silently record terminal output to
|
If enabled, this configuration can silently record terminal output to
|
||||||
`~/.terminal_history`: Kitty scrollback on window close, live tmux pane
|
`~/.terminal_history`: Kitty scrollback on window close, live tmux pane
|
||||||
streams, zellij pane snapshots on exit, and full paru/yay output. These logs
|
streams, zellij pane snapshots on exit, and full paru/yay output. These logs
|
||||||
can contain command output, file contents, and secrets printed to the
|
can contain command output, file contents, and secrets printed to the
|
||||||
|
|||||||
@@ -693,7 +693,7 @@ def test_customization_notes_render_as_aside():
|
|||||||
path = Path(__file__).parent / "manual" / "07-customization.md"
|
path = Path(__file__).parent / "manual" / "07-customization.md"
|
||||||
_, body = mt.parse(path)
|
_, body = mt.parse(path)
|
||||||
out = build_manual.prettify(body)
|
out = build_manual.prettify(body)
|
||||||
assert out.count('<Aside type="note" title="Note">') == 1, f"expected exactly one Note aside:\n{out}"
|
assert out.count('<Aside type="note" title="Note">') >= 1, f"expected at least one Note aside:\n{out}"
|
||||||
aside = out.split('<Aside type="note" title="Note">')[1].split("</Aside>")[0]
|
aside = out.split('<Aside type="note" title="Note">')[1].split("</Aside>")[0]
|
||||||
assert aside.count(" - ") == 4, f"expected exactly 4 bullets inside the aside:\n{aside}"
|
assert aside.count(" - ") == 4, f"expected exactly 4 bullets inside the aside:\n{aside}"
|
||||||
assert "- Command shadows (rm, cat, ls, ...) react immediately" in aside
|
assert "- Command shadows (rm, cat, ls, ...) react immediately" in aside
|
||||||
|
|||||||
Reference in New Issue
Block a user