{"id":44063825,"url":"https://github.com/rockset/cli","last_synced_at":"2026-02-08T03:01:47.011Z","repository":{"id":203373531,"uuid":"261550516","full_name":"rockset/cli","owner":"rockset","description":"Rockset cli","archived":false,"fork":false,"pushed_at":"2024-04-09T23:12:26.000Z","size":1761,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-04-10T01:21:11.348Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.rockset.com/rockset-cli/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rockset.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-05-05T18:20:50.000Z","updated_at":"2023-11-16T15:39:48.000Z","dependencies_parsed_at":"2023-11-15T01:25:53.942Z","dependency_job_id":"acfb7611-b3cb-4b24-9138-a6a700187f3b","html_url":"https://github.com/rockset/cli","commit_stats":null,"previous_names":["rockset/cli"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/rockset/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockset%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockset%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockset%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockset%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rockset","download_url":"https://codeload.github.com/rockset/cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockset%2Fcli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29218632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-08T02:25:35.815Z","status":"ssl_error","status_checked_at":"2026-02-08T02:24:27.970Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-08T03:00:49.791Z","updated_at":"2026-02-08T03:01:47.005Z","avatar_url":"https://github.com/rockset.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rockset CLI\n[![Build status](https://github.com/rockset/cli/actions/workflows/build.yaml/badge.svg)](https://github.com/rockset/cli/actions/workflows/build.yaml)\n[![Documentation](https://godoc.org/github.com/rockset/cli?status.svg)](http://godoc.org/github.com/rockset/cli)\n[![License](https://img.shields.io/github/license/rockset/cli.svg?maxAge=2592000)](https://github.com/rockset/cli/LICENSE)\n[![GitHub issues](https://img.shields.io/github/issues/rockset/cli.svg)](https://github.com/rockset/cli/issues)\n[![Release](https://img.shields.io/github/release/rockset/cli.svg?label=Release)](https://github.com/rockset/cli/releases)\n\n## Installation\n\n```shell\nbrew tap rockset/cli\nbrew install rockset\n```\n\n## Usage\n\nThe Rockset cli can be used as an alternative to the [console](https://console.rockset.com/),\nand is built as a UNIX tool to allow it to be used in pipes.\n\n![screen recording](vhs/quickstart.gif)\n\n### Query\n\n![screen recording](vhs/query.gif)\n\nThere are three ways to query a collection, either using the first argument as the SQL\n\n```shell\n$ rockset query 'SELECT COUNT(*) FROM _events'\n┌────────┐\n│ ?COUNT │\n├────────┤\n│  2488  │\n└────────┘\nElapsed time: 22 ms\n```\n\nOr using interactive mode\n\n```shell\n$ rockset query\n[R]\u003e SELECT COUNT(*)\n\u003e\u003e\u003e FROM _events;\n┌────────┐\n│ ?COUNT │\n├────────┤\n│  2488  │\n└────────┘\nElapsed time: 26 ms\n^D\n```\n\nAnd reading the SQL from stdin\n\n```shell\n$ rockset query \u003c query.sql\n┌────────┐\n│ ?COUNT │\n├────────┤\n│  2488  │\n└────────┘\nElapsed time: 24 ms\n```\n\n### Cloning a collection\n\nA common workflow is to want to clone a collection, but change a few settings, e.g. the retention.\nThis can be done using two commands\n\n```shell\nrockset get collection --output - movies | rockset create collection --input - --retention 12h movies2\n```\n\n![screen recording](vhs/clone.gif)\n\n## Configuration\n\nThe Rockset CLI requires having access to either an API key or a bearer token, together with an apiserver,\nand in the case of a bearer token also the organization.\n\nThese are called authentication context.\n\nThe easiest way to authenticate is using the console login, which is invoked using\n```shell\n$ rockset auth login\n```\n\nThe authentication token is valid for 24h, and can be refreshed using\n\n```shell\n$ rockset auth refresh\n```\n\nTo view which authentication contacts are available\n\n```shell\n$ rockset list contexts\nAvailable Authentication Contexts:\napikeys:\n   dev (https://api.usw2a1.dev.rockset.com)\n   test (https://api.use1a1.rockset.com)\nbearer tokens:\n-\u003e usw2a1 (https://api.usw2a1.rockset.com)\n$ rockset use context prod\nusing prod\n$ rockset list contexts\nAvailable Authentication Contexts:\napikeys:\n   dev (https://api.usw2a1.dev.rockset.com)\n-\u003e test (https://api.use1a1.rockset.com)\nbearer tokens:\n   usw2a1 (https://api.usw2a1.rockset.com)\n```\n\n### Configuration File\n\nThe configuration file is stored in `~/.config/rockset/config.yaml`\n\n```yaml\n---\ncurrent: dev\nkeys:\n  dev:\n    apikey: ...\n    apiserver: api.usw2a1.dev.rockset.com\ntokens:\n  prod:\n    token: ...\n    org: rockset-test\n    apiserver: api.usw2a1.dev.rockset.com\n    expiration: 2023-10-17T08:13:48.785337-07:00\n```\n\n## Building\n\n```\ngo build -o rockset\n```\n\n## Testing\n\n```\ngo test ./...\n```\n\n## Releasing\n\nThe repo uses `goreleaser` to publish new releases\n\n```shell\ngoreleaser release --snapshot\n```\n\n### Integration testing\n\nRequires the environment variable `ROCKSET_APIKEY` to be set.\n\n```\ngo test -tags=integration ./...\n```\n\n### Create recordings\n\nWe use [vhs](https://github.com/charmbracelet/vhs) to record terminal sessions\n\n```\nvhs vhs/demo.tape\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockset%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frockset%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockset%2Fcli/lists"}