https://github.com/cueblox/blox

CueBlox CLI
https://github.com/cueblox/blox

Last synced: 3 months ago
JSON representation

CueBlox CLI

• Host: GitHub
• URL: https://github.com/cueblox/blox
• Owner: cueblox
• License: mit
• Created: 2021-04-06T14:41:39.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T23:35:03.000Z (over 1 year ago)
• Last Synced: 2024-06-18T23:13:02.323Z (5 months ago)
• Language: Go
• Homepage: https://www.cueblox.com
• Size: 1.9 MB
• Stars: 46
• Watchers: 5
• Forks: 3
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-cue - cueblox - The All-in-One Batteries Included Data Framework (Projects)

README

        
# Blox

Blox is the CLI for working with [CueBlox](https://cueblox.com).

## What is Blox?

See our rapidly-evolving documentation [here](https://github.com/cueblox/blox/blob/main/dogfood/data/pages/index.md)

## Vocabulary

### Blox

A Blox is a collection of DataSets, grouped into a Schema, and distributed as a repository.

These Blox can be consumed using the `blox` CLI to provide data validation and generation for your content repositories, ensuring type safety across your content.

### DataSet

A DataSet is a type with a strongly defined schema, using [Cue](https://cuelang.org).

See [examples](./dogfood/schemata/profile_v1.cue)

### Schema

A Schema is a Cue file definition of one or more DataSets, with some metadata to help connect some dots for the `blox` CLI.

See [examples](./dogfood/schemata)

### Repository

Collection of schemas, distributed via HTTP with a `manifest.json`. Can be downloaded by the `blox` CLI.