broll 0.4.0

Terminal session recorder with searchable, timestamped output
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Session {
    pub id: String,
    pub name: Option<String>,
    pub started_at: DateTime<Utc>,
    pub ended_at: Option<DateTime<Utc>>,
    pub group: Option<String>,
    pub terminal_label: String,
    pub tags: Vec<String>,
    pub shell: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Chunk {
    pub id: i64,
    pub session_id: String,
    pub timestamp: DateTime<Utc>,
    pub content: String,
    /// "input" for commands, "output" for terminal output
    pub kind: ChunkKind,
    /// Working directory when an input command was run (None for output chunks).
    #[serde(default)]
    pub cwd: Option<String>,
    /// Exit code of an input command, filled in once it finishes (None for output).
    #[serde(default)]
    pub exit_code: Option<i64>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum ChunkKind {
    Input,
    Output,
}

impl ChunkKind {
    pub fn as_str(&self) -> &str {
        match self {
            ChunkKind::Input => "input",
            ChunkKind::Output => "output",
        }
    }

    pub fn from_str(s: &str) -> Self {
        match s {
            "input" => ChunkKind::Input,
            _ => ChunkKind::Output,
        }
    }
}

/// A user-added note attached to a session.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Annotation {
    pub id: i64,
    pub session_id: String,
    pub created_at: DateTime<Utc>,
    pub content: String,
}

/// Portable representation of a full session for export/import.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SessionExport {
    pub version: u32,
    pub session: Session,
    pub chunks: Vec<Chunk>,
    pub annotations: Vec<Annotation>,
}

/// A search result pointing to a specific chunk with context.
#[derive(Debug, Clone, Serialize)]
pub struct SearchHit {
    pub session: Session,
    pub chunk: Chunk,
}