@rockset/cli
Advanced tools
Readme
Official Rockset CLI
$ npm install -g @rockset/cli
$ rock COMMAND
running command...
$ rock (-v|--version|version)
@rockset/cli/0.0.27 linux-x64 node-v12.16.3
$ rock --help [COMMAND]
USAGE
$ rock COMMAND
...
rock api:apikeys:createApiKey BODYrock api:apikeys:createApiKeyAdmin BODY USERrock api:apikeys:deleteApiKey NAMErock api:apikeys:deleteApiKeyAdmin NAME USERrock api:apikeys:listApiKeysrock api:apikeys:listApiKeysAdmin USERrock api:collections:createCollection WORKSPACE BODYrock api:collections:deleteCollection WORKSPACE COLLECTIONrock api:collections:getCollection WORKSPACE COLLECTIONrock api:collections:listCollectionsrock api:collections:listQueryLambdasInCollection WORKSPACE COLLECTIONrock api:collections:workspaceCollections WORKSPACErock api:documents:addDocuments WORKSPACE COLLECTION BODYrock api:documents:deleteDocuments WORKSPACE COLLECTION BODYrock api:documents:patchDocuments WORKSPACE COLLECTION BODYrock api:integrations:createIntegration BODYrock api:integrations:deleteIntegration INTEGRATIONrock api:integrations:getIntegration INTEGRATIONrock api:integrations:listIntegrationsrock api:orgs:getOrganizationrock api:queries:query BODYrock api:queryLambdas:createQueryLambda WORKSPACE BODYrock api:queryLambdas:deleteQueryLambda WORKSPACE QUERYLAMBDArock api:queryLambdas:executeQueryLambda WORKSPACE QUERYLAMBDA VERSION [BODY]rock api:queryLambdas:getQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSIONrock api:queryLambdas:listAllQueryLambdasrock api:queryLambdas:listQueryLambdaVersions WORKSPACE QUERYLAMBDArock api:queryLambdas:listQueryLambdasInWorkspace WORKSPACErock api:queryLambdas:updateQueryLambda WORKSPACE QUERYLAMBDA BODYrock api:users:createUser BODYrock api:users:deleteUser USERrock api:users:getCurrentUserrock api:users:listUsersrock api:workspaces:childWorkspaces WORKSPACErock api:workspaces:createWorkspace BODYrock api:workspaces:deleteWorkspace WORKSPACErock api:workspaces:getWorkspace WORKSPACErock api:workspaces:listWorkspacesrock autocomplete [SHELL]rock help [COMMAND]rock project:download:collectionsrock project:download:lambdasrock project:initrock project:resolve NAMErock update [CHANNEL]rock api:apikeys:createApiKey BODYCreate API Key
USAGE
$ rock api:apikeys:createApiKey BODY
ARGUMENTS
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create API Key
Create a new API key for the authenticated user.
Endpoint: POST: /v1/orgs/self/users/self/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#createapikey
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/createApiKey.ts
rock api:apikeys:createApiKeyAdmin BODY USERCreate API Key for any user (admin only)
USAGE
$ rock api:apikeys:createApiKeyAdmin BODY USER
ARGUMENTS
BODY JSON object
USER
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create API Key for any user (admin only)
Create a new API key for any user (admin only).
Endpoint: POST: /v1/orgs/self/users/{user}/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#createapikeyadmin
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/createApiKeyAdmin.ts
rock api:apikeys:deleteApiKey NAMEDelete API Key
USAGE
$ rock api:apikeys:deleteApiKey NAME
ARGUMENTS
NAME name of the API key
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete API Key
Delete an API key for the authenticated user.
Endpoint: DELETE: /v1/orgs/self/users/self/apikeys/{name}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteapikey
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/deleteApiKey.ts
rock api:apikeys:deleteApiKeyAdmin NAME USERDelete API Key for any user (admin only)
USAGE
$ rock api:apikeys:deleteApiKeyAdmin NAME USER
ARGUMENTS
NAME name of the API key
USER
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete API Key for any user (admin only)
Delete an API key for any user (admin only).
Endpoint: DELETE: /v1/orgs/self/users/{user}/apikeys/{name}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteapikeyadmin
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/deleteApiKeyAdmin.ts
rock api:apikeys:listApiKeysList API Keys
USAGE
$ rock api:apikeys:listApiKeys
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List API Keys
List all API keys for the authenticated user.
Endpoint: GET: /v1/orgs/self/users/self/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#listapikeys
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/listApiKeys.ts
rock api:apikeys:listApiKeysAdmin USERList API Keys for any user (admin only)
USAGE
$ rock api:apikeys:listApiKeysAdmin USER
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List API Keys for any user (admin only)
List all API keys for any user (admin only).
Endpoint: GET: /v1/orgs/self/users/{user}/apikeys
Endpoint Documentation: https://docs.rockset.com/rest-api#listapikeysadmin
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/apikeys/listApiKeysAdmin.ts
rock api:collections:createCollection WORKSPACE BODYCreate Collection
USAGE
$ rock api:collections:createCollection WORKSPACE BODY
ARGUMENTS
WORKSPACE name of the workspace
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create Collection
Create new collection in a workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#createcollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/createCollection.ts
rock api:collections:deleteCollection WORKSPACE COLLECTIONDelete Collection
USAGE
$ rock api:collections:deleteCollection WORKSPACE COLLECTION
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete Collection
Delete a collection and all its documents from Rockset.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/collections/{collection}
Endpoint Documentation: https://docs.rockset.com/rest-api#deletecollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/deleteCollection.ts
rock api:collections:getCollection WORKSPACE COLLECTIONGet Collection
USAGE
$ rock api:collections:getCollection WORKSPACE COLLECTION
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Collection
Get details about a collection.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/collections/{collection}
Endpoint Documentation: https://docs.rockset.com/rest-api#getcollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/getCollection.ts
rock api:collections:listCollectionsList Collections
USAGE
$ rock api:collections:listCollections
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Collections
Retrieve all collections in an organization.
Endpoint: GET: /v1/orgs/self/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#listcollections
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/listCollections.ts
rock api:collections:listQueryLambdasInCollection WORKSPACE COLLECTIONGet Query Lambdas
USAGE
$ rock api:collections:listQueryLambdasInCollection WORKSPACE COLLECTION
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Query Lambdas
Get all Query Lambdas that hit a specific Rockset Collection.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/collections/{collection}/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdasincollection
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/listQueryLambdasInCollection.ts
rock api:collections:workspaceCollections WORKSPACEList Collections for Workspace
USAGE
$ rock api:collections:workspaceCollections WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Collections for Workspace
Retrieve all collections in a workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/collections
Endpoint Documentation: https://docs.rockset.com/rest-api#workspacecollections
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/collections/workspaceCollections.ts
rock api:documents:addDocuments WORKSPACE COLLECTION BODYAdd Documents
USAGE
$ rock api:documents:addDocuments WORKSPACE COLLECTION BODY
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Add Documents
Add documents to a collection in Rockset.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Endpoint Documentation: https://docs.rockset.com/rest-api#adddocuments
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/documents/addDocuments.ts
rock api:documents:deleteDocuments WORKSPACE COLLECTION BODYDelete Documents
USAGE
$ rock api:documents:deleteDocuments WORKSPACE COLLECTION BODY
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete Documents
Delete documents from a collection in Rockset.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Endpoint Documentation: https://docs.rockset.com/rest-api#deletedocuments
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/documents/deleteDocuments.ts
rock api:documents:patchDocuments WORKSPACE COLLECTION BODYPatch Documents
USAGE
$ rock api:documents:patchDocuments WORKSPACE COLLECTION BODY
ARGUMENTS
WORKSPACE name of the workspace
COLLECTION name of the collection
BODY JSON Patch objects
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Patch Documents
Patch documents in a collection
Endpoint: PATCH: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Endpoint Documentation: https://docs.rockset.com/rest-api#patchdocuments
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/documents/patchDocuments.ts
rock api:integrations:createIntegration BODYCreate Integration
USAGE
$ rock api:integrations:createIntegration BODY
ARGUMENTS
BODY integration credentials
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create Integration
Create a new integration with Rockset.
Endpoint: POST: /v1/orgs/self/integrations
Endpoint Documentation: https://docs.rockset.com/rest-api#createintegration
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/createIntegration.ts
rock api:integrations:deleteIntegration INTEGRATIONDelete Integration
USAGE
$ rock api:integrations:deleteIntegration INTEGRATION
ARGUMENTS
INTEGRATION name of the integration
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete Integration
Remove an integration.
Endpoint: DELETE: /v1/orgs/self/integrations/{integration}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteintegration
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/deleteIntegration.ts
rock api:integrations:getIntegration INTEGRATIONGet Integration
USAGE
$ rock api:integrations:getIntegration INTEGRATION
ARGUMENTS
INTEGRATION name of the integration
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Integration
Get information about a single integration.
Endpoint: GET: /v1/orgs/self/integrations/{integration}
Endpoint Documentation: https://docs.rockset.com/rest-api#getintegration
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/getIntegration.ts
rock api:integrations:listIntegrationsList Integrations
USAGE
$ rock api:integrations:listIntegrations
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Integrations
List all integrations for organization.
Endpoint: GET: /v1/orgs/self/integrations
Endpoint Documentation: https://docs.rockset.com/rest-api#listintegrations
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/integrations/listIntegrations.ts
rock api:orgs:getOrganizationGet Organization
USAGE
$ rock api:orgs:getOrganization
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Organization
Retrieve information about current organization.
Endpoint: GET: /v1/orgs/self
Endpoint Documentation: https://docs.rockset.com/rest-api#getorganization
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/orgs/getOrganization.ts
rock api:queries:query BODYQuery
USAGE
$ rock api:queries:query BODY
ARGUMENTS
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Query
Make a SQL query to Rockset.
Endpoint: POST: /v1/orgs/self/queries
Endpoint Documentation: https://docs.rockset.com/rest-api#query
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queries/query.ts
rock api:queryLambdas:createQueryLambda WORKSPACE BODYCreate Query Lambda
USAGE
$ rock api:queryLambdas:createQueryLambda WORKSPACE BODY
ARGUMENTS
WORKSPACE name of the workspace
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create Query Lambda
Create a Query Lambda in given workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#createquerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/createQueryLambda.ts
rock api:queryLambdas:deleteQueryLambda WORKSPACE QUERYLAMBDADelete Query Lambda
USAGE
$ rock api:queryLambdas:deleteQueryLambda WORKSPACE QUERYLAMBDA
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete Query Lambda
Delete a Query Lambda.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}
Endpoint Documentation: https://docs.rockset.com/rest-api#deletequerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/deleteQueryLambda.ts
rock api:queryLambdas:executeQueryLambda WORKSPACE QUERYLAMBDA VERSION [BODY]Run Query Lambda
USAGE
$ rock api:queryLambdas:executeQueryLambda WORKSPACE QUERYLAMBDA VERSION [BODY]
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
VERSION version
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Run Query Lambda
Run a particular version of a Query Lambda.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}
Endpoint Documentation: https://docs.rockset.com/rest-api#executequerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/executeQueryLambda.ts
rock api:queryLambdas:getQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSIONGet Query Lambda Version
USAGE
$ rock api:queryLambdas:getQueryLambdaVersion WORKSPACE QUERYLAMBDA VERSION
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
VERSION version
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Query Lambda Version
Get a specific version of a Query Lambda
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions/{version}
Endpoint Documentation: https://docs.rockset.com/rest-api#getquerylambdaversion
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/getQueryLambdaVersion.ts
rock api:queryLambdas:listAllQueryLambdasList Query Lambdas
USAGE
$ rock api:queryLambdas:listAllQueryLambdas
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Query Lambdas
List all Query Lambdas.
Endpoint: GET: /v1/orgs/self/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#listallquerylambdas
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listAllQueryLambdas.ts
rock api:queryLambdas:listQueryLambdaVersions WORKSPACE QUERYLAMBDAList Query Lambda Versions
USAGE
$ rock api:queryLambdas:listQueryLambdaVersions WORKSPACE QUERYLAMBDA
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Query Lambda Versions
List all versions of a Query Lambda.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdaversions
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listQueryLambdaVersions.ts
rock api:queryLambdas:listQueryLambdasInWorkspace WORKSPACEList Query Lambdas
USAGE
$ rock api:queryLambdas:listQueryLambdasInWorkspace WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Query Lambdas
List all Query Lambdas under given workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/lambdas
Endpoint Documentation: https://docs.rockset.com/rest-api#listquerylambdasinworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/listQueryLambdasInWorkspace.ts
rock api:queryLambdas:updateQueryLambda WORKSPACE QUERYLAMBDA BODYUpdate Query Lambda
USAGE
$ rock api:queryLambdas:updateQueryLambda WORKSPACE QUERYLAMBDA BODY
ARGUMENTS
WORKSPACE name of the workspace
QUERYLAMBDA name of the Query Lambda
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Update Query Lambda
Create a new version of a Query Lambda in given workspace.
Endpoint: POST: /v1/orgs/self/ws/{workspace}/lambdas/{queryLambda}/versions
Endpoint Documentation: https://docs.rockset.com/rest-api#updatequerylambda
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/queryLambdas/updateQueryLambda.ts
rock api:users:createUser BODYCreate User
USAGE
$ rock api:users:createUser BODY
ARGUMENTS
BODY JSON object
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create User
Create a new user for an organization.
Endpoint: POST: /v1/orgs/self/users
Endpoint Documentation: https://docs.rockset.com/rest-api#createuser
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/createUser.ts
rock api:users:deleteUser USERDelete User
USAGE
$ rock api:users:deleteUser USER
ARGUMENTS
USER user email
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete User
Delete a user from an organization.
Endpoint: DELETE: /v1/orgs/self/users/{user}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteuser
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/deleteUser.ts
rock api:users:getCurrentUserGet Current User
USAGE
$ rock api:users:getCurrentUser
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Current User
Retrieve currently active user.
Endpoint: GET: /v1/orgs/self/users/self
Endpoint Documentation: https://docs.rockset.com/rest-api#getcurrentuser
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/getCurrentUser.ts
rock api:users:listUsersList Users
USAGE
$ rock api:users:listUsers
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Users
Retrieve all users for an organization.
Endpoint: GET: /v1/orgs/self/users
Endpoint Documentation: https://docs.rockset.com/rest-api#listusers
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/users/listUsers.ts
rock api:workspaces:childWorkspaces WORKSPACEList Workspaces
USAGE
$ rock api:workspaces:childWorkspaces WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Workspaces
List workspaces under given workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}/ws
Endpoint Documentation: https://docs.rockset.com/rest-api#childworkspaces
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/childWorkspaces.ts
rock api:workspaces:createWorkspace BODYCreate Workspace
USAGE
$ rock api:workspaces:createWorkspace BODY
ARGUMENTS
BODY workspace details
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Create Workspace
Create a new workspace in your org.
Endpoint: POST: /v1/orgs/self/ws
Endpoint Documentation: https://docs.rockset.com/rest-api#createworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/createWorkspace.ts
rock api:workspaces:deleteWorkspace WORKSPACEDelete Workspace
USAGE
$ rock api:workspaces:deleteWorkspace WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Delete Workspace
Remove a workspace.
Endpoint: DELETE: /v1/orgs/self/ws/{workspace}
Endpoint Documentation: https://docs.rockset.com/rest-api#deleteworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/deleteWorkspace.ts
rock api:workspaces:getWorkspace WORKSPACEGet Workspace
USAGE
$ rock api:workspaces:getWorkspace WORKSPACE
ARGUMENTS
WORKSPACE name of the workspace
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
Get Workspace
Get information about a single workspace.
Endpoint: GET: /v1/orgs/self/ws/{workspace}
Endpoint Documentation: https://docs.rockset.com/rest-api#getworkspace
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/getWorkspace.ts
rock api:workspaces:listWorkspacesList Workspaces
USAGE
$ rock api:workspaces:listWorkspaces
OPTIONS
-f, --file=file The config file to execute this command from. Format must be [yaml|json]
-h, --help show CLI help
DESCRIPTION
List Workspaces
List all workspaces.
Endpoint: GET: /v1/orgs/self/ws
Endpoint Documentation: https://docs.rockset.com/rest-api#listworkspaces
This command is a simple wrapper around the above endpoint. Please view further documentation at the url above.
See code: src/commands/api/workspaces/listWorkspaces.ts
rock autocomplete [SHELL]display autocomplete installation instructions
USAGE
$ rock autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ rock autocomplete
$ rock autocomplete bash
$ rock autocomplete zsh
$ rock autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
rock help [COMMAND]display help for rock
USAGE
$ rock help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
rock project:download:collectionsDownload collection entities from Rockset to your local project.
USAGE
$ rock project:download:collections
OPTIONS
-h, --help show CLI help
DESCRIPTION
Download collection entities from Rockset to your local project.
See code: src/commands/project/download/collections.ts
rock project:download:lambdasDownload Query Lambda entities from Rockset to your local project.
USAGE
$ rock project:download:lambdas
OPTIONS
-h, --help show CLI help
-t, --tag=
Specify a value to download all Query Lambda versions tagged with this tag.
Query Lambdas that do not have a version with this tag name will be skipped.
DESCRIPTION
Download Query Lambda entities from Rockset to your local project.
See code: src/commands/project/download/lambdas.ts
rock project:initInitialize your project.
USAGE
$ rock project:init
OPTIONS
-h, --help show CLI help
DESCRIPTION
Initialize your project.
This command initializes your project with a rockconfig.json file.
See code: src/commands/project/init.ts
rock project:resolve NAMEResolve the absolute path of an entity in the current project.
USAGE
$ rock project:resolve NAME
ARGUMENTS
NAME The fully qualified name of the entity you wish to resolve
OPTIONS
-e, --entity=lambda|workspace [default: lambda] the type of entity you wish to resolve
-h, --help show CLI help
--exists Return with an error if file does not exist
DESCRIPTION
Resolve the absolute path of an entity in the current project.
You must specify the fully qualified name of the entity: eg. 'commons.foo'.
You must specify the type of entity that will be resolved.
See code: src/commands/project/resolve.ts
rock update [CHANNEL]update the rock CLI
USAGE
$ rock update [CHANNEL]
See code: @oclif/plugin-update
FAQs
Unknown package
We found that @rockset/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.