MCPcopy
hub / github.com/brimdata/zui

github.com/brimdata/zui @v1.18.0 sqlite

repository ↗ · DeepWiki ↗ · release v1.18.0 ↗
3,415 symbols 9,689 edges 1,411 files 9 documented · 0%
README

Zui

The Official Front-End to the Zed Lake

Zui

Zui is a desktop app for exploring and working with data.

Highlights:

  • Drag-and-drop data ingest
  • Automatic detection of common data formats
  • Schema inference during ingest
  • Beautiful result views for nested or tabular data
  • Named queries with version history
  • Query session history to keep track of your work
  • Pinnable query fragments to keep your search box uncluttered
  • Right-click menus for pivoting and filtering

Ready To Try It Out?

Download Zui for your operating system.

Refer to the installation guide and release notes for more information.

Powered By Zed

Zed offers an innovative approach to working with data known as "Super-Structured Data".

Behind Zui is a local Zed Lake instance where you can load your data into pools and use the powerful Zed language to search, analyze, and transform it. Use it to:

  • Explore deeply nested JSON objects
  • View Parquet and Arrow IPC stream files
  • Clean up CSV files by adding type information
  • Search heterogeneous NDJSON logs
  • Transform data from a legacy database's CDC logs
  • Investigate Zeek security logs

Zed provides a system to make working with data easier and more efficient. The storage layer, type system, query language, and zq command-line utility are just a few of the tools Zed offers to the data community.

Formerly Known as "Brim"

For many years, the app was known as Brim, named after the company Brim Data that created it. In 2023, it was renamed to Zui (a play on "Zed User Interface") to better reflect its connection to the Zed technology that powers it.

Zui retains the security-specific features that made Brim popular while expanding its reach to anyone who has data to work with. For example, you'll still find the customized views, histograms, and correlations relevant to the security domain appearing in Zui via its nascent plugin system. In the future, developers will be able to create custom plugins that make Zui even more effective for their specific needs.

Related Packages

This Zui code repository is actually a monorepo (managed with nx) that includes several packages on which the app depends. They may also be used as standalone tools. These include:

Need Help?

Please browse the support resources to review common problems and helpful tips before opening an issue.

Contributing

We welcome your contributions! Please refer to our contributing guide for information on how to get involved in development.

Join the Community

Join our public Slack workspace to stay up to date on announcements, ask questions, and exchange tips with other users.

Extension points exported contracts — how you extend this code

Type (Interface)
(no doc) [14 implementers]
packages/zed-js/src/types/types.ts
Updater (Interface)
(no doc) [4 implementers]
apps/zui/src/domain/updates/types.ts
Value (Interface)
(no doc) [14 implementers]
packages/zed-js/src/values/types.ts
Loader (Interface)
(no doc) [4 implementers]
apps/zui/src/domain/loads/types.ts
Response (Interface)
(no doc)
packages/zed-js/src/types.ts
SecurityEventInterface (Interface)
(no doc) [3 implementers]
apps/zui/src/ppl/detail/models/security-event.ts
PoolLoadArgs (Interface)
(no doc)
packages/zed-js/src/types.ts
QueryPinInterface (Interface)
(no doc) [3 implementers]
apps/zui/src/js/state/Editor/types.ts

Core symbols most depended-on inside this repo

dispatch
called by 178
apps/zui/src/js/api/api-domain.ts
toString
called by 153
packages/zed-js/src/types/types.ts
push
called by 123
apps/zui/src/modules/history.ts
create
called by 112
packages/zed-js/src/types/types.ts
select
called by 99
apps/zui/src/core/main/select.ts
click
called by 97
packages/zui-player/helpers/test-app.ts
on
called by 92
apps/zui/src/util/typed-emitter.ts
createHandler
called by 87
apps/zui/src/core/handlers.ts

Shape

Function 1,695
Method 1,178
Class 501
Interface 38
Struct 3

Languages

TypeScript100%
Go1%

Modules by API surface

packages/zed-wasm/lib/wasm_exec.js49 symbols
packages/zui-player/helpers/test-app.ts44 symbols
apps/zui/src/zui-kit/table/table-view-api.ts43 symbols
apps/zui/src/js/models/Errors.ts37 symbols
apps/zui/src/test/shared/__mocks__/electron.ts32 symbols
apps/zui/src/zui-kit/table/column.ts26 symbols
apps/zui/src/core/when/ast.ts23 symbols
packages/zed-js/src/values/record.ts22 symbols
apps/zui/src/domain/loads/load-context.ts22 symbols
apps/zui/src/electron/windows/window-manager.ts21 symbols
apps/zui/src/models/session.ts20 symbols
apps/zui/src/views/tab-bar/handler.ts19 symbols

Dependencies from manifests, versioned

github.com/JohnCGriffin/overflowv0.0.0-2021101920005 · 1×
github.com/agnivade/levenshteinv1.1.1 · 1×
github.com/alecthomas/unitsv0.0.0-2019092402574 · 1×
github.com/andybalholm/brotliv1.0.5 · 1×
github.com/apache/arrow/go/v14v14.0.0 · 1×
github.com/apache/thriftv0.17.0 · 1×
github.com/araddon/dateparsev0.0.0-2021042916200 · 1×
github.com/aws/aws-sdk-gov1.36.17 · 1×
github.com/axiomhq/hyperloglogv0.0.0-2019111213214 · 1×
github.com/brimdata/zedv1.12.0 · 1×
github.com/dgryski/go-metrov0.0.0-2018010904463 · 1×
github.com/goccy/go-jsonv0.10.2 · 1×

For agents

$ claude mcp add zui \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact