unisonweb/unison

Automatically record UCM session as a transcript

Open

#2,249 opened on Jul 19, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (6,624 stars) (304 forks)batch import
codebase-manager / ucmfeature requesthelp wanted

Description

When working in Unison, situations like these come up often:

  • I need to capture a transcript of what I've been doing in Unison, but don't realize it until after the fact, and making a transcript by hand can be a bit tedious.
  • I accidentally fix an issue and I don't have a record of what I did to fix it.
  • I run into an error message and I want to know what I did last time to work around it.

This is a feature request to automatically record a transcript of every UCM session. This could be made off-and-onable in the .config file.

Contributor guide

Tech stack
None
Domain
clideveloper experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with Unison's transcript systemKnowledge of Unison CLI internalsUnderstanding of .config file handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
15
Research direction
Investigate the UCM's session management in the `unison cli` package, focusing on how user input is handled and how transcripts are currently generated via the `transcript` command. Propose a mechanism to automatically log all commands and outputs to a timestamped transcript file, with an optional toggle in the config file. Review any existing issues or PRs related to session logging. Start a discussion by commenting on this issue with a proposed implementation plan.