Documentation
¶
Index ¶
- Constants
- func BackendDBPath(root string) string
- func BashTasksDir(root string) string
- func CacheDir(root string) string
- func CompanionPath(root string) string
- func DataDir(root string) string
- func DeepDocModelsDir(root string) string
- func DefaultConfigDir(appName string) string
- func ExpandTilde(path string) string
- func HNSWDataDir(root string) string
- func Join(root string, parts ...string) string
- func LegacySessionsDir(root string) string
- func LogsDir(root string) string
- func MigrateLegacySessionDirs(root string) (int, error)
- func PlansDir(root string) string
- func RAGSQLiteDBPath(root string) string
- func RemoveSessionData(root, sessionID string) error
- func ResolveRoot(explicit string) string
- func SessionArtifactsAudioDir(root, sessionID string) string
- func SessionArtifactsDir(root, sessionID string) string
- func SessionArtifactsImagesDir(root, sessionID string) string
- func SessionArtifactsWebDir(root, sessionID string) string
- func SessionDir(root, sessionID string) string
- func SessionLogPath(root, sessionID string) string
- func SessionPastesDir(root, sessionID string) string
- func SessionPastesImagesDir(root, sessionID string) string
- func SessionPastesOtherDir(root, sessionID string) string
- func SessionPastesTextDir(root, sessionID string) string
- func SessionPermissionsPath(root, sessionID string) string
- func SessionPlansDir(root, sessionID string) string
- func SessionScreenshotsDir(root, sessionID string) string
- func SessionStoreDir(root string) string
- func SessionToolsDir(root, sessionID string) string
- func SessionsDir(root string) string
- func SkillsDir(root string) string
- func StorageDir(root string) string
- func TasksDir(root string) string
- func TitleModelsDir(root string) string
- func TmpDir(root string) string
- func WorkspacesDir(root string) string
Constants ¶
const EnvRuntimeRoot = "SESHAT_RUNTIME_ROOT"
Variables ¶
This section is empty.
Functions ¶
func BackendDBPath ¶
BackendDBPath is the path of the SQLite database of the runtime (seshat.db) under the runtime root.
func BashTasksDir ¶
BashTasksDir is the directory of the output files of background shell commands (tmp/bash-tasks) under the runtime root.
func CompanionPath ¶
CompanionPath is the path of the companion state file (companion.json) under the runtime root.
func DataDir ¶
DataDir is the directory of the data the runtime keeps (indexes, sessions, databases) under the runtime root.
func DeepDocModelsDir ¶
DeepDocModelsDir holds the ONNX models (det.ort, rec.ort, layout.ort, tsr.ort, ocr.res) that back pkg/nativedoc's native OCR/layout/table pipeline - fetched by scripts/install-deepdoc-models.sh from https://huggingface.co/InfiniFlow/deepdoc (Apache-2.0), mirroring docling-serve's own .venv provisioning convention.
func DefaultConfigDir ¶
DefaultConfigDir returns the platform-appropriate config directory for the given application name.
- Linux / BSD: $XDG_CONFIG_HOME/<appName> or ~/.config/<appName>
- macOS: ~/.config/<appName> (XDG convention — familiar for CLI tools, avoids the space in "Library/Application Support")
- Windows: %APPDATA%\<appName> (e.g. C:\Users\<user>\AppData\Roaming\<appName>)
SESHAT_RUNTIME_ROOT overrides everything — callers should check that first.
func ExpandTilde ¶
ExpandTilde replaces a leading "~" with the current user's home directory. Go's filepath package does not do this automatically.
func HNSWDataDir ¶
HNSWDataDir is the directory of the HNSW vector indexes (data/hnsw) under the runtime root.
func LegacySessionsDir ¶
LegacySessionsDir is where per-session data lived before v1.2.59.
func MigrateLegacySessionDirs ¶
MigrateLegacySessionDirs moves what older versions wrote under sessions/{id}/ to workspaces/{id}/, and a permissions.json to data/permissions/{id}.json. It never overwrites: a file that already exists at the destination stays, and what could not be moved stays where it was. It is safe to run on every start. It returns how many session directories it moved something out of.
func RAGSQLiteDBPath ¶
RAGSQLiteDBPath is the fallback vector store used when the embedded HNSW backend can't be opened, and the store of the installs that ran when HNSW did not build on Windows (before 1.2.73).
func RemoveSessionData ¶
RemoveSessionData deletes the directory of a session and its permissions file. It is what deleting a session leaves to the filesystem. An id that is not a plain name is refused rather than followed.
func ResolveRoot ¶
ResolveRoot returns the runtime root: explicit when it is not blank, otherwise the SESHAT_RUNTIME_ROOT environment variable, otherwise ~/.config/seshat, and a seshat directory under the temporary directory when no home can be found. A leading "~" is expanded and the path is cleaned.
func SessionArtifactsAudioDir ¶
SessionArtifactsAudioDir holds TTS output and STT input audio files.
func SessionArtifactsDir ¶
SessionArtifactsDir is the parent for all agent-produced artifacts.
func SessionArtifactsImagesDir ¶
SessionArtifactsImagesDir holds AI-generated images (not browser screenshots).
func SessionArtifactsWebDir ¶
SessionArtifactsWebDir holds web-scraped/fetched content.
func SessionDir ¶
SessionDir is the directory of one session: the per-session directory under WorkspacesDir.
func SessionLogPath ¶
SessionLogPath is the per-session log file for errors and diagnostics.
func SessionPastesDir ¶
SessionPastesDir holds persisted pasted attachments for the session.
func SessionPastesImagesDir ¶
SessionPastesImagesDir is the directory of the image pastes of a session.
func SessionPastesOtherDir ¶
SessionPastesOtherDir is the directory of the pastes of a session that are neither text nor images.
func SessionPastesTextDir ¶
SessionPastesTextDir is the directory of the text pastes of a session.
func SessionPermissionsPath ¶
SessionPermissionsPath is the file of the permissions granted to a session ("always allow this tool"). It is outside the session directory on purpose: the agent can write there, and a grant it could edit would be a grant it could give itself.
func SessionPlansDir ¶
SessionPlansDir holds plan-mode markdown files for the session.
func SessionScreenshotsDir ¶
SessionScreenshotsDir holds browser screenshots under artifacts/.
func SessionStoreDir ¶
SessionStoreDir is the directory of the persisted sessions (data/sessions) under the runtime root.
func SessionToolsDir ¶
SessionToolsDir holds browser downloads and tool-produced output files.
func SessionsDir ¶
SessionsDir is the directory that holds the per-session directories. The name is kept; the directory is WorkspacesDir.
func StorageDir ¶
StorageDir is the directory of the local object storage under the runtime root.
func TasksDir ¶
TasksDir is the directory of the background task files (tmp/tasks) under the runtime root.
func TitleModelsDir ¶
TitleModelsDir stores tiny local models dedicated to cheap background tasks such as automatic session-title generation.
func WorkspacesDir ¶
WorkspacesDir holds the per-session directories.
Types ¶
This section is empty.
Source Files