file.proto

Generated from proto/blitz/v1/file.proto by proto-gen-md-diagrams.

Imports

Import	Description
google/protobuf/timestamp.proto

Options

Name	Value	Description
go_package	github.com/retail-cortex/blitz/proto/blitz/v1

blitz.v1 Diagram

classDiagram
direction LR
%% Mermaid Diagram for package: blitz.v1

%% One entry of a folder, as ListDir returns it.

class FileEntry {
  + string name
  + string path
  + FileKind kind
  + int64 size
  + google.protobuf.Timestamp modified
  + string git
  + string hidden
  + string agent_rule
  + string staged
  + bool ignored
}
FileEntry --> `FileKind`

%% Request message for FileService.ListDir.

class ListDirRequest {
  + string workspace
  + string path
  + bool show_hidden
}

%% Response message for FileService.ListDir.

class ListDirResponse {
  + List~FileEntry~ entries
  + bool truncated
  + bool repo
}
ListDirResponse --> `FileEntry`

%% Request message for FileService.ReadFile.

class ReadFileRequest {
  + string workspace
  + string path
}

%% Response message for FileService.ReadFile.

class ReadFileResponse {
  + string path
  + string text
  + string version
  + int64 size
  + bool binary
  + bool too_large
  + string agent_rule
}

%% Request message for FileService.ReadPreview.

class ReadPreviewRequest {
  + string workspace
  + string path
}

%% Response message for FileService.ReadPreview.

class ReadPreviewResponse {
  + string path
  + string mime
  + bytes data
}

%% Request message for FileService.WriteFile.

class WriteFileRequest {
  + string workspace
  + string path
  + string text
  + string version
}

%% Response message for FileService.WriteFile.

class WriteFileResponse {
  + string version
}

%% Request message for FileService.WriteBinaryFile.

class WriteBinaryFileRequest {
  + string workspace
  + string path
  + bytes data
  + string version
}

%% Response message for FileService.WriteBinaryFile.

class WriteBinaryFileResponse {
  + string version
}

%% Request message for FileService.CreateFolder.

class CreateFolderRequest {
  + string workspace
  + string path
}

%% Response message for FileService.CreateFolder.

class CreateFolderResponse {
}

%% Request message for FileService.RenameFile.

class RenameFileRequest {
  + string workspace
  + string from
  + string to
}

%% Response message for FileService.RenameFile.

class RenameFileResponse {
}

%% Request message for FileService.DeleteFile.

class DeleteFileRequest {
  + string workspace
  + string path
}

%% Response message for FileService.DeleteFile.

class DeleteFileResponse {
}

%% Request message for FileService.GitFileAction.

class GitFileActionRequest {
  + string workspace
  + string path
  + GitAction action
}
GitFileActionRequest --> `GitAction`

%% Response message for FileService.GitFileAction.

class GitFileActionResponse {
}

%% One commit in a history.

class FileRevision {
  + string commit
  + string short
  + string author
  + google.protobuf.Timestamp when
  + string subject
  + string path
  + List~string~ parents
  + string email
  + int32 added
  + int32 removed
  + int32 files
}

%% Request message for FileService.GetFileHistory.

class GetFileHistoryRequest {
  + string workspace
  + string path
  + int32 limit
  + int32 skip
}

%% Response message for FileService.GetFileHistory.

class GetFileHistoryResponse {
  + List~FileRevision~ revisions
  + bool more
}
GetFileHistoryResponse --> `FileRevision`

%% Request message for FileService.GetFileRevisionDiff.

class GetFileRevisionDiffRequest {
  + string workspace
  + string path
  + string commit
  + RevisionDiff against
  + string other_commit
}
GetFileRevisionDiffRequest --> `RevisionDiff`

%% Response message for FileService.GetFileRevisionDiff.

class GetFileRevisionDiffResponse {
  + string diff
  + bool truncated
}

%% Request message for FileService.RestoreFileRevision.

class RestoreFileRevisionRequest {
  + string workspace
  + string path
  + string commit
  + string version
  + bool preview
}

%% A file a folder's restore puts back.

class RestoredFile {
  + string path
  + bool recreated
}

%% Response message for FileService.RestoreFileRevision.

class RestoreFileRevisionResponse {
  + string version
  + List~RestoredFile~ files
}
RestoreFileRevisionResponse --> `RestoredFile`

%% Request message for FileService.RenderDocx.

class RenderDocxRequest {
  + string workspace
  + string path
  + string markdown
  + List~DocxDiagram~ diagrams
}
RenderDocxRequest --> `DocxDiagram`

%% A diagram drawn as a picture, for RenderDocx.

class DocxDiagram {
  + string source
  + bytes png
  + int32 width
  + int32 height
}

%% Response message for FileService.RenderDocx.

class RenderDocxResponse {
  + bytes data
}

%% Request message for FileService.FindFiles.

class FindFilesRequest {
  + string workspace
  + string query
  + int32 limit
  + bool folders
}

%% Response message for FileService.FindFiles.

class FindFilesResponse {
  + List~string~ paths
}

%% Request message for FileService.StatFiles.

class StatFilesRequest {
  + string workspace
  + List~string~ paths
}

%% Response message for FileService.StatFiles.

class StatFilesResponse {
  + Map~string,  string~ versions
}

%% Request message for FileService.ReadTable.

class ReadTableRequest {
  + string workspace
  + string path
  + string search
  + List~ColumnFilter~ filters
  + int32 sort_column
  + bool descending
  + int32 offset
  + int32 limit
}
ReadTableRequest --> `ColumnFilter`

%% ColumnFilter is a filter on one column (0-based).

class ColumnFilter {
  + int32 column
  + string expr
}

%% TableColumn is a table's column, as its first rows show it.

class TableColumn {
  + string name
  + string kind
  + int32 empty
  + double min
  + double max
  + string intent
}

%% TableRow is a row of a table, numbered from 1 (the header not counted).

class TableRow {
  + int32 number
  + List~string~ cells
}

%% Response message for FileService.ReadTable.

class ReadTableResponse {
  + List~TableColumn~ columns
  + List~TableRow~ rows
  + int32 matched
  + int32 total
  + bool sorted
  + bool latin1
}
ReadTableResponse --> `TableColumn`
ReadTableResponse --> `TableRow`
%% What a folder entry is.

class FileKind{
  <<enumeration>>
  FILE_KIND_UNSPECIFIED
  FILE_KIND_FILE
  FILE_KIND_FOLDER
  FILE_KIND_SYMLINK
}
%% GitAction is what GitFileAction does.

class GitAction{
  <<enumeration>>
  GIT_ACTION_UNSPECIFIED
  GIT_ACTION_STAGE
  GIT_ACTION_UNSTAGE
  GIT_ACTION_DISCARD
  GIT_ACTION_IGNORE
  GIT_ACTION_UNIGNORE
}
%% What a revision is compared with.

class RevisionDiff{
  <<enumeration>>
  REVISION_DIFF_UNSPECIFIED
  REVISION_DIFF_NOW
  REVISION_DIFF_PARENT
  REVISION_DIFF_OTHER
}
class FileService {
  <<service>>
  +ListDir(ListDirRequest) ListDirResponse
  +ReadFile(ReadFileRequest) ReadFileResponse
  +ReadPreview(ReadPreviewRequest) ReadPreviewResponse
  +WriteFile(WriteFileRequest) WriteFileResponse
  +WriteBinaryFile(WriteBinaryFileRequest) WriteBinaryFileResponse
  +CreateFolder(CreateFolderRequest) CreateFolderResponse
  +RenameFile(RenameFileRequest) RenameFileResponse
  +DeleteFile(DeleteFileRequest) DeleteFileResponse
  +GitFileAction(GitFileActionRequest) GitFileActionResponse
  +GetFileHistory(GetFileHistoryRequest) GetFileHistoryResponse
  +GetFileRevisionDiff(GetFileRevisionDiffRequest) GetFileRevisionDiffResponse
  +RestoreFileRevision(RestoreFileRevisionRequest) RestoreFileRevisionResponse
  +RenderDocx(RenderDocxRequest) RenderDocxResponse
  +FindFiles(FindFilesRequest) FindFilesResponse
  +StatFiles(StatFilesRequest) StatFilesResponse
  +ReadTable(ReadTableRequest) ReadTableResponse
}
FileService --> `ListDirRequest`
FileService --> `ListDirResponse`
FileService --> `ReadFileRequest`
FileService --> `ReadFileResponse`
FileService --> `ReadPreviewRequest`
FileService --> `ReadPreviewResponse`
FileService --> `WriteFileRequest`
FileService --> `WriteFileResponse`
FileService --> `WriteBinaryFileRequest`
FileService --> `WriteBinaryFileResponse`
FileService --> `CreateFolderRequest`
FileService --> `CreateFolderResponse`
FileService --> `RenameFileRequest`
FileService --> `RenameFileResponse`
FileService --> `DeleteFileRequest`
FileService --> `DeleteFileResponse`
FileService --> `GitFileActionRequest`
FileService --> `GitFileActionResponse`
FileService --> `GetFileHistoryRequest`
FileService --> `GetFileHistoryResponse`
FileService --> `GetFileRevisionDiffRequest`
FileService --> `GetFileRevisionDiffResponse`
FileService --> `RestoreFileRevisionRequest`
FileService --> `RestoreFileRevisionResponse`
FileService --> `RenderDocxRequest`
FileService --> `RenderDocxResponse`
FileService --> `FindFilesRequest`
FileService --> `FindFilesResponse`
FileService --> `StatFilesRequest`
FileService --> `StatFilesResponse`
FileService --> `ReadTableRequest`
FileService --> `ReadTableResponse`

Service: FileService

FQN: blitz.v1

FileService is the workspace's files for the user: the desktop app's explorer and editor. Paths are relative to the workspace, with "/" separators; nothing outside the workspace, and never .git. The agent's path rules bind the agent, not the user: blocked and read-only paths are reported, not refused. The agent's next turn is told of the user's changes. Every request names its workspace by absolute directory. Errors carry an ErrorInfo detail; a write over a changed file is FILE_CHANGED.

FileService Diagram

classDiagram
direction LR
class FileService {
  <<service>>
  +ListDir(ListDirRequest) ListDirResponse
  +ReadFile(ReadFileRequest) ReadFileResponse
  +ReadPreview(ReadPreviewRequest) ReadPreviewResponse
  +WriteFile(WriteFileRequest) WriteFileResponse
  +WriteBinaryFile(WriteBinaryFileRequest) WriteBinaryFileResponse
  +CreateFolder(CreateFolderRequest) CreateFolderResponse
  +RenameFile(RenameFileRequest) RenameFileResponse
  +DeleteFile(DeleteFileRequest) DeleteFileResponse
  +GitFileAction(GitFileActionRequest) GitFileActionResponse
  +GetFileHistory(GetFileHistoryRequest) GetFileHistoryResponse
  +GetFileRevisionDiff(GetFileRevisionDiffRequest) GetFileRevisionDiffResponse
  +RestoreFileRevision(RestoreFileRevisionRequest) RestoreFileRevisionResponse
  +RenderDocx(RenderDocxRequest) RenderDocxResponse
  +FindFiles(FindFilesRequest) FindFilesResponse
  +StatFiles(StatFilesRequest) StatFilesResponse
  +ReadTable(ReadTableRequest) ReadTableResponse
}
FileService --> `ListDirRequest`
FileService --> `ListDirResponse`
FileService --> `ReadFileRequest`
FileService --> `ReadFileResponse`
FileService --> `ReadPreviewRequest`
FileService --> `ReadPreviewResponse`
FileService --> `WriteFileRequest`
FileService --> `WriteFileResponse`
FileService --> `WriteBinaryFileRequest`
FileService --> `WriteBinaryFileResponse`
FileService --> `CreateFolderRequest`
FileService --> `CreateFolderResponse`
FileService --> `RenameFileRequest`
FileService --> `RenameFileResponse`
FileService --> `DeleteFileRequest`
FileService --> `DeleteFileResponse`
FileService --> `GitFileActionRequest`
FileService --> `GitFileActionResponse`
FileService --> `GetFileHistoryRequest`
FileService --> `GetFileHistoryResponse`
FileService --> `GetFileRevisionDiffRequest`
FileService --> `GetFileRevisionDiffResponse`
FileService --> `RestoreFileRevisionRequest`
FileService --> `RestoreFileRevisionResponse`
FileService --> `RenderDocxRequest`
FileService --> `RenderDocxResponse`
FileService --> `FindFilesRequest`
FileService --> `FindFilesResponse`
FileService --> `StatFilesRequest`
FileService --> `StatFilesResponse`
FileService --> `ReadTableRequest`
FileService --> `ReadTableResponse`

Method	Parameter (In)	Parameter (Out)	Description
ListDir	ListDirRequest	ListDirResponse	A folder’s entries, folders first.
ReadFile	ReadFileRequest	ReadFileResponse	A file for the editor.
ReadPreview	ReadPreviewRequest	ReadPreviewResponse	An image, PDF or sound file’s bytes, to show or play it.
WriteFile	WriteFileRequest	WriteFileResponse	Writes a file if it still has the version read (FILE_CHANGED if not).
WriteBinaryFile	WriteBinaryFileRequest	WriteBinaryFileResponse	Writes bytes (a PDF the editor exported) as WriteFile writes text.
CreateFolder	CreateFolderRequest	CreateFolderResponse	Creates a folder, and any missing folders above it; it must not exist.
RenameFile	RenameFileRequest	RenameFileResponse	Moves a file or folder; the destination must not exist.
DeleteFile	DeleteFileRequest	DeleteFileResponse	Deletes a file, or a folder with everything in it.
GitFileAction	GitFileActionRequest	GitFileActionResponse	Runs a git action on a file or folder of the workspace: stage it, unstage it, discard its changes (back to the last commit), or add it to the workspace’s .gitignore or take it out again. Git runs with the repository’s filter drivers and fsmonitor switched off. NOT_A_REPOSITORY outside one; IGNORED_ELSEWHERE when another rule still ignores what’s taken out (pattern and source in the metadata).
GetFileHistory	GetFileHistoryRequest	GetFileHistoryResponse	The commits that changed a file (following renames), a folder or the whole workspace (path “”), newest first, a page at a time, with their parents for a graph (View revisions). NOT_A_REPOSITORY outside one.
GetFileRevisionDiff	GetFileRevisionDiffRequest	GetFileRevisionDiffResponse	A unified diff for a file or folder: from a revision to now, what a revision changed, or between two revisions (BAD_REVISION for one that isn’t a commit of the history).
RestoreFileRevision	RestoreFileRevisionRequest	RestoreFileRevisionResponse	Puts a file back as it was in a revision, if it still has the version given (FILE_CHANGED if not); or a folder’s files changed or deleted since, keeping those added since (preview: only says which). The index is left alone.
RenderDocx	RenderDocxRequest	RenderDocxResponse	Markdown written as a Word document (.docx), its images read beside the file it belongs to; the caller writes it (Export as Word, /export).
FindFiles	FindFilesRequest	FindFilesResponse	Files whose path matches a query, best first (Go to file).
StatFiles	StatFilesRequest	StatFilesResponse	Files’ current versions, to notice changes made elsewhere.
ReadTable	ReadTableRequest	ReadTableResponse	A page of a CSV or TSV file’s rows, searched, filtered by column and sorted, streamed so a file of any size can be read (NOT_A_TABLE, BAD_FILTER, BAD_PATH, FILE_NOT_FOUND).

Enum: FileKind

FQN: blitz.v1.FileKind

What a folder entry is.

Name	Ordinal	Description
FILE_KIND_UNSPECIFIED	0
FILE_KIND_FILE	1
FILE_KIND_FOLDER	2
FILE_KIND_SYMLINK	3

Enum: GitAction

FQN: blitz.v1.GitAction

GitAction is what GitFileAction does.

Name	Ordinal	Description
GIT_ACTION_UNSPECIFIED	0
GIT_ACTION_STAGE	1	git add: the file, or everything changed under the folder.
GIT_ACTION_UNSTAGE	2	git restore –staged: out of the index, the working copy kept.
GIT_ACTION_DISCARD	3	git restore –staged –worktree –source=HEAD: back to the last commit.
GIT_ACTION_IGNORE	4	A line for it ("/path", “/folder/”) in the workspace’s .gitignore.
GIT_ACTION_UNIGNORE	5	That line taken out of the workspace’s .gitignore again.

Enum: RevisionDiff

FQN: blitz.v1.RevisionDiff

What a revision is compared with.

Name	Ordinal	Description
REVISION_DIFF_UNSPECIFIED	0	Not said: as REVISION_DIFF_NOW.
REVISION_DIFF_NOW	1	The working copy: how it differs from the revision.
REVISION_DIFF_PARENT	2	Its parent: what the revision changed.
REVISION_DIFF_OTHER	3	Another revision (other_commit).

FileKind Diagram

classDiagram
direction LR
%% What a folder entry is.

class FileKind{
  <<enumeration>>
  FILE_KIND_UNSPECIFIED
  FILE_KIND_FILE
  FILE_KIND_FOLDER
  FILE_KIND_SYMLINK
}

GitAction Diagram

classDiagram
direction LR
%% GitAction is what GitFileAction does.

class GitAction{
  <<enumeration>>
  GIT_ACTION_UNSPECIFIED
  GIT_ACTION_STAGE
  GIT_ACTION_UNSTAGE
  GIT_ACTION_DISCARD
  GIT_ACTION_IGNORE
  GIT_ACTION_UNIGNORE
}

RevisionDiff Diagram

classDiagram
direction LR
%% What a revision is compared with.

class RevisionDiff{
  <<enumeration>>
  REVISION_DIFF_UNSPECIFIED
  REVISION_DIFF_NOW
  REVISION_DIFF_PARENT
  REVISION_DIFF_OTHER
}

FileEntry Diagram

classDiagram
direction LR

%% One entry of a folder, as ListDir returns it.

class FileEntry {
  + string name
  + string path
  + FileKind kind
  + int64 size
  + google.protobuf.Timestamp modified
  + string git
  + string hidden
  + string agent_rule
  + string staged
  + bool ignored
}
FileEntry --> `FileKind`

ListDirRequest Diagram

classDiagram
direction LR

%% Request message for FileService.ListDir.

class ListDirRequest {
  + string workspace
  + string path
  + bool show_hidden
}

ListDirResponse Diagram

classDiagram
direction LR

%% Response message for FileService.ListDir.

class ListDirResponse {
  + List~FileEntry~ entries
  + bool truncated
  + bool repo
}
ListDirResponse --> `FileEntry`

ReadFileRequest Diagram

classDiagram
direction LR

%% Request message for FileService.ReadFile.

class ReadFileRequest {
  + string workspace
  + string path
}

ReadFileResponse Diagram

classDiagram
direction LR

%% Response message for FileService.ReadFile.

class ReadFileResponse {
  + string path
  + string text
  + string version
  + int64 size
  + bool binary
  + bool too_large
  + string agent_rule
}

ReadPreviewRequest Diagram

classDiagram
direction LR

%% Request message for FileService.ReadPreview.

class ReadPreviewRequest {
  + string workspace
  + string path
}

ReadPreviewResponse Diagram

classDiagram
direction LR

%% Response message for FileService.ReadPreview.

class ReadPreviewResponse {
  + string path
  + string mime
  + bytes data
}

WriteFileRequest Diagram

classDiagram
direction LR

%% Request message for FileService.WriteFile.

class WriteFileRequest {
  + string workspace
  + string path
  + string text
  + string version
}

WriteFileResponse Diagram

classDiagram
direction LR

%% Response message for FileService.WriteFile.

class WriteFileResponse {
  + string version
}

WriteBinaryFileRequest Diagram

classDiagram
direction LR

%% Request message for FileService.WriteBinaryFile.

class WriteBinaryFileRequest {
  + string workspace
  + string path
  + bytes data
  + string version
}

WriteBinaryFileResponse Diagram

classDiagram
direction LR

%% Response message for FileService.WriteBinaryFile.

class WriteBinaryFileResponse {
  + string version
}

CreateFolderRequest Diagram

classDiagram
direction LR

%% Request message for FileService.CreateFolder.

class CreateFolderRequest {
  + string workspace
  + string path
}

CreateFolderResponse Diagram

classDiagram
direction LR

%% Response message for FileService.CreateFolder.

class CreateFolderResponse {
}

RenameFileRequest Diagram

classDiagram
direction LR

%% Request message for FileService.RenameFile.

class RenameFileRequest {
  + string workspace
  + string from
  + string to
}

RenameFileResponse Diagram

classDiagram
direction LR

%% Response message for FileService.RenameFile.

class RenameFileResponse {
}

DeleteFileRequest Diagram

classDiagram
direction LR

%% Request message for FileService.DeleteFile.

class DeleteFileRequest {
  + string workspace
  + string path
}

DeleteFileResponse Diagram

classDiagram
direction LR

%% Response message for FileService.DeleteFile.

class DeleteFileResponse {
}

GitFileActionRequest Diagram

classDiagram
direction LR

%% Request message for FileService.GitFileAction.

class GitFileActionRequest {
  + string workspace
  + string path
  + GitAction action
}
GitFileActionRequest --> `GitAction`

GitFileActionResponse Diagram

classDiagram
direction LR

%% Response message for FileService.GitFileAction.

class GitFileActionResponse {
}

FileRevision Diagram

classDiagram
direction LR

%% One commit in a history.

class FileRevision {
  + string commit
  + string short
  + string author
  + google.protobuf.Timestamp when
  + string subject
  + string path
  + List~string~ parents
  + string email
  + int32 added
  + int32 removed
  + int32 files
}

GetFileHistoryRequest Diagram

classDiagram
direction LR

%% Request message for FileService.GetFileHistory.

class GetFileHistoryRequest {
  + string workspace
  + string path
  + int32 limit
  + int32 skip
}

GetFileHistoryResponse Diagram

classDiagram
direction LR

%% Response message for FileService.GetFileHistory.

class GetFileHistoryResponse {
  + List~FileRevision~ revisions
  + bool more
}
GetFileHistoryResponse --> `FileRevision`

GetFileRevisionDiffRequest Diagram

classDiagram
direction LR

%% Request message for FileService.GetFileRevisionDiff.

class GetFileRevisionDiffRequest {
  + string workspace
  + string path
  + string commit
  + RevisionDiff against
  + string other_commit
}
GetFileRevisionDiffRequest --> `RevisionDiff`

GetFileRevisionDiffResponse Diagram

classDiagram
direction LR

%% Response message for FileService.GetFileRevisionDiff.

class GetFileRevisionDiffResponse {
  + string diff
  + bool truncated
}

RestoreFileRevisionRequest Diagram

classDiagram
direction LR

%% Request message for FileService.RestoreFileRevision.

class RestoreFileRevisionRequest {
  + string workspace
  + string path
  + string commit
  + string version
  + bool preview
}

RestoredFile Diagram

classDiagram
direction LR

%% A file a folder's restore puts back.

class RestoredFile {
  + string path
  + bool recreated
}

RestoreFileRevisionResponse Diagram

classDiagram
direction LR

%% Response message for FileService.RestoreFileRevision.

class RestoreFileRevisionResponse {
  + string version
  + List~RestoredFile~ files
}
RestoreFileRevisionResponse --> `RestoredFile`

RenderDocxRequest Diagram

classDiagram
direction LR

%% Request message for FileService.RenderDocx.

class RenderDocxRequest {
  + string workspace
  + string path
  + string markdown
  + List~DocxDiagram~ diagrams
}
RenderDocxRequest --> `DocxDiagram`

DocxDiagram Diagram

classDiagram
direction LR

%% A diagram drawn as a picture, for RenderDocx.

class DocxDiagram {
  + string source
  + bytes png
  + int32 width
  + int32 height
}

RenderDocxResponse Diagram

classDiagram
direction LR

%% Response message for FileService.RenderDocx.

class RenderDocxResponse {
  + bytes data
}

FindFilesRequest Diagram

classDiagram
direction LR

%% Request message for FileService.FindFiles.

class FindFilesRequest {
  + string workspace
  + string query
  + int32 limit
  + bool folders
}

FindFilesResponse Diagram

classDiagram
direction LR

%% Response message for FileService.FindFiles.

class FindFilesResponse {
  + List~string~ paths
}

StatFilesRequest Diagram

classDiagram
direction LR

%% Request message for FileService.StatFiles.

class StatFilesRequest {
  + string workspace
  + List~string~ paths
}

StatFilesResponse Diagram

classDiagram
direction LR

%% Response message for FileService.StatFiles.

class StatFilesResponse {
  + Map~string,  string~ versions
}

ReadTableRequest Diagram

classDiagram
direction LR

%% Request message for FileService.ReadTable.

class ReadTableRequest {
  + string workspace
  + string path
  + string search
  + List~ColumnFilter~ filters
  + int32 sort_column
  + bool descending
  + int32 offset
  + int32 limit
}
ReadTableRequest --> `ColumnFilter`

ColumnFilter Diagram

classDiagram
direction LR

%% ColumnFilter is a filter on one column (0-based).

class ColumnFilter {
  + int32 column
  + string expr
}

TableColumn Diagram

classDiagram
direction LR

%% TableColumn is a table's column, as its first rows show it.

class TableColumn {
  + string name
  + string kind
  + int32 empty
  + double min
  + double max
  + string intent
}

TableRow Diagram

classDiagram
direction LR

%% TableRow is a row of a table, numbered from 1 (the header not counted).

class TableRow {
  + int32 number
  + List~string~ cells
}

ReadTableResponse Diagram

classDiagram
direction LR

%% Response message for FileService.ReadTable.

class ReadTableResponse {
  + List~TableColumn~ columns
  + List~TableRow~ rows
  + int32 matched
  + int32 total
  + bool sorted
  + bool latin1
}
ReadTableResponse --> `TableColumn`
ReadTableResponse --> `TableRow`

Message: FileEntry

FQN: blitz.v1.FileEntry

One entry of a folder, as ListDir returns it.

Field	Ordinal	Type	Description
name	1	string
path	2	string
kind	3	FileKind
size	4	int64
modified	5	google.protobuf.Timestamp
git	6	string	modified, added, deleted, renamed, untracked, conflicted; “changed” for a folder with changes under it; "" when clean or not in git.
hidden	7	string	Why it’s hidden by default: “blocked”, “ignored”, “dot”, “agent” (an agent instruction file such as AGENTS.md), or “”.
agent_rule	8	string	The agent’s rule for it: “blocked”, “read_only”, or “”.
staged	9	string	How much of a file’s change is staged: “all”, “some” (staged, then changed again), or "" (none, or a folder).
ignored	10	bool	Git ignores it, whatever hidden says (a dotfile git ignores is hidden as “dot”).

Message: ListDirRequest

FQN: blitz.v1.ListDirRequest

Request message for FileService.ListDir.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string	"" for the workspace itself.
show_hidden	3	bool

Message: ListDirResponse

FQN: blitz.v1.ListDirResponse

Response message for FileService.ListDir.

Field	Ordinal	Type	Label	Description
entries	1	FileEntry	Repeated
truncated	2	bool		More than 5,000 entries; the rest are left out.
repo	3	bool		The workspace is in a git repository.

Message: ReadFileRequest

FQN: blitz.v1.ReadFileRequest

Request message for FileService.ReadFile.

Field	Ordinal	Type	Label	Description
workspace	1	string
path	2	string

Message: ReadFileResponse

FQN: blitz.v1.ReadFileResponse

Response message for FileService.ReadFile.

Field	Ordinal	Type	Description
path	1	string
text	2	string	"" for binary and too-large files.
version	3	string	The content’s SHA-256, for WriteFile.
size	4	int64
binary	5	bool
too_large	6	bool
agent_rule	7	string

Message: ReadPreviewRequest

FQN: blitz.v1.ReadPreviewRequest

Request message for FileService.ReadPreview.

Field	Ordinal	Type	Label	Description
workspace	1	string
path	2	string

Message: ReadPreviewResponse

FQN: blitz.v1.ReadPreviewResponse

Response message for FileService.ReadPreview.

Field	Ordinal	Type	Description
path	1	string
mime	2	string	image/png, image/jpeg, image/gif, image/webp, image/svg+xml, image/bmp, image/x-icon, application/pdf, audio/wav, audio/mpeg, audio/mp4, audio/aac, audio/ogg or audio/flac.
data	3	bytes

Message: WriteFileRequest

FQN: blitz.v1.WriteFileRequest

Request message for FileService.WriteFile.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string
text	3	string
version	4	string	The version read; "" when the file must not exist yet.

Message: WriteFileResponse

FQN: blitz.v1.WriteFileResponse

Response message for FileService.WriteFile.

Field	Ordinal	Type	Label	Description
version	1	string

Message: WriteBinaryFileRequest

FQN: blitz.v1.WriteBinaryFileRequest

Request message for FileService.WriteBinaryFile.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string
data	3	bytes
version	4	string	The version read; "" when the file must not exist yet.

Message: WriteBinaryFileResponse

FQN: blitz.v1.WriteBinaryFileResponse

Response message for FileService.WriteBinaryFile.

Field	Ordinal	Type	Label	Description
version	1	string

Message: CreateFolderRequest

FQN: blitz.v1.CreateFolderRequest

Request message for FileService.CreateFolder.

Field	Ordinal	Type	Label	Description
workspace	1	string
path	2	string

Message: CreateFolderResponse

FQN: blitz.v1.CreateFolderResponse

Response message for FileService.CreateFolder.

Field	Ordinal	Type	Label	Description

Message: RenameFileRequest

FQN: blitz.v1.RenameFileRequest

Request message for FileService.RenameFile.

Field	Ordinal	Type
workspace	1	string
from	2	string
to	3	string

Message: RenameFileResponse

FQN: blitz.v1.RenameFileResponse

Response message for FileService.RenameFile.

Field	Ordinal	Type	Label	Description

Message: DeleteFileRequest

FQN: blitz.v1.DeleteFileRequest

Request message for FileService.DeleteFile.

Field	Ordinal	Type	Label	Description
workspace	1	string
path	2	string

Message: DeleteFileResponse

FQN: blitz.v1.DeleteFileResponse

Response message for FileService.DeleteFile.

Field	Ordinal	Type	Label	Description

Message: GitFileActionRequest

FQN: blitz.v1.GitFileActionRequest

Request message for FileService.GitFileAction.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string	Workspace-relative, with “/”.
action	3	GitAction

Message: GitFileActionResponse

FQN: blitz.v1.GitFileActionResponse

Response message for FileService.GitFileAction.

Field	Ordinal	Type	Label	Description

Message: FileRevision

FQN: blitz.v1.FileRevision

One commit in a history.

Field	Ordinal	Type	Label	Description
commit	1	string		The full hash, and abbreviated.
short	2	string
author	3	string
when	4	google.protobuf.Timestamp
subject	5	string		The commit message’s first line.
path	6	string		A file’s path at that commit, from the repository’s root; "" in a folder’s history.
parents	7	string	Repeated	Its parents (full hashes), as the history is simplified to the path.
email	8	string
added	9	int32		The lines it added and removed in the file or folder, in how many files.
removed	10	int32
files	11	int32

Message: GetFileHistoryRequest

FQN: blitz.v1.GetFileHistoryRequest

Request message for FileService.GetFileHistory.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string	Workspace-relative, with “/”: a file, a folder, or "" for the workspace.
limit	3	int32	At most this many (0: 100; never more than 500).
skip	4	int32	After this many of the newest.

Message: GetFileHistoryResponse

FQN: blitz.v1.GetFileHistoryResponse

Response message for FileService.GetFileHistory.

Field	Ordinal	Type	Label	Description
revisions	1	FileRevision	Repeated
more	2	bool		Older revisions follow.

Message: GetFileRevisionDiffRequest

FQN: blitz.v1.GetFileRevisionDiffRequest

Request message for FileService.GetFileRevisionDiff.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string	A file, a folder, or "" for the workspace.
commit	3	string	A commit hash.
against	4	RevisionDiff
other_commit	5	string	The later revision, for REVISION_DIFF_OTHER.

Message: GetFileRevisionDiffResponse

FQN: blitz.v1.GetFileRevisionDiffResponse

Response message for FileService.GetFileRevisionDiff.

Field	Ordinal	Type	Label	Description
diff	1	string		Unified diff; "" when the same.
truncated	2	bool		Cut short at 2 MB, at a line.

Message: RestoreFileRevisionRequest

FQN: blitz.v1.RestoreFileRevisionRequest

Request message for FileService.RestoreFileRevision.

Field	Ordinal	Type	Description
workspace	1	string
path	2	string	A file, a folder, or "" for the workspace.
commit	3	string
version	4	string	A file’s version as the caller last saw it ("" when it doesn’t exist).
preview	5	bool	For a folder: only say which files it would put back.

Message: RestoredFile

FQN: blitz.v1.RestoredFile

A file a folder's restore puts back.

Field	Ordinal	Type	Label	Description
path	1	string		Workspace-relative, with “/”.
recreated	2	bool		It was deleted since, and comes back.

Message: RestoreFileRevisionResponse

FQN: blitz.v1.RestoreFileRevisionResponse

Response message for FileService.RestoreFileRevision.

Field	Ordinal	Type	Label	Description
version	1	string		A file’s new version.
files	2	RestoredFile	Repeated	A folder’s files it put back (or would, with preview).

Message: RenderDocxRequest

FQN: blitz.v1.RenderDocxRequest

Request message for FileService.RenderDocx.

Field	Ordinal	Type	Label	Description
workspace	1	string
path	2	string		The Markdown file it’s from, for its images ("" for none).
markdown	3	string
diagrams	4	DocxDiagram	Repeated	Its ```mermaid diagrams, drawn by the caller (the service can’t run Mermaid); one not here stays as its code.

Message: DocxDiagram

FQN: blitz.v1.DocxDiagram

A diagram drawn as a picture, for RenderDocx.

Field	Ordinal	Type	Description
source	1	string	The ```mermaid block’s text: its lines, without the fences.
png	2	bytes	A PNG of it.
width	3	int32	Its size in CSS pixels (the PNG may have more, for sharpness).
height	4	int32

Message: RenderDocxResponse

FQN: blitz.v1.RenderDocxResponse

Response message for FileService.RenderDocx.

Field	Ordinal	Type	Label	Description
data	1	bytes

Message: FindFilesRequest

FQN: blitz.v1.FindFilesRequest

Request message for FileService.FindFiles.

Field	Ordinal	Type	Description
workspace	1	string
query	2	string
limit	3	int32	At most this many (default 50).
folders	4	bool	Also the folders the files are in, with a trailing slash (for @ mentions).

Message: FindFilesResponse

FQN: blitz.v1.FindFilesResponse

Response message for FileService.FindFiles.

Field	Ordinal	Type	Label	Description
paths	1	string	Repeated

Message: StatFilesRequest

FQN: blitz.v1.StatFilesRequest

Request message for FileService.StatFiles.

Field	Ordinal	Type	Label	Description
workspace	1	string
paths	2	string	Repeated

Message: StatFilesResponse

FQN: blitz.v1.StatFilesResponse

Response message for FileService.StatFiles.

Field	Ordinal	Type	Label	Description
versions	1	string, string	Map	Path to version; "" for a file that’s gone.

Message: ReadTableRequest

FQN: blitz.v1.ReadTableRequest

Request message for FileService.ReadTable.

Field	Ordinal	Type	Label	Description
workspace	1	string
path	2	string
search	3	string		Rows with this in a cell, ignoring case ("": all).
filters	4	ColumnFilter	Repeated	Each column’s filter: a comparison (">5", “<=0”, “=north”, “!=x”), a range (“10..20”), “empty”, “!empty”, else text the cell contains.
sort_column	5	int32		The column to sort by, 1-based; 0: file order.
descending	6	bool
offset	7	int32
limit	8	int32		0: 100.

Message: ColumnFilter

FQN: blitz.v1.ColumnFilter

ColumnFilter is a filter on one column (0-based).

Field	Ordinal	Type	Label	Description
column	1	int32
expr	2	string

Message: TableColumn

FQN: blitz.v1.TableColumn

TableColumn is a table's column, as its first rows show it.

Field	Ordinal	Type	Description
name	1	string
kind	2	string	number, date, text or empty.
empty	3	int32	Empty cells in the rows profiled.
min	4	double	A number column’s range in the rows profiled.
max	5	double
intent	6	string	What it holds, as a model described it (search.enrich), if it has.

Message: TableRow

FQN: blitz.v1.TableRow

TableRow is a row of a table, numbered from 1 (the header not counted).

Field	Ordinal	Type	Label	Description
number	1	int32
cells	2	string	Repeated

Message: ReadTableResponse

FQN: blitz.v1.ReadTableResponse

Response message for FileService.ReadTable.

Field	Ordinal	Type	Label	Description
columns	1	TableColumn	Repeated
rows	2	TableRow	Repeated
matched	3	int32		Rows that matched, and rows in all.
total	4	int32
sorted	5	bool		False when a sort was asked for but too many rows matched (more than 200,000): the rows are in file order; filter first.
latin1	6	bool		The file is Latin-1 (Windows-1252), decoded.