Cue CLI tool

The CLI tool lets you sync a local folder to Cue or compare a local folder's content to that on Cue.

Use

Pre-steps

You need an API key in order to authenticate with the CLI tool.

• Go to your profile page and create an API key.
• Save the value in the environment variable CUE_API_KEY on your system*

• You can also specify it using the --key flag but it is more convenient and safe to use an environment variable.

What commands?

• Run npx @qaecy/cue-cli --help to list all supported commands.
• Use the --help flag on any command to see all supported flags on that command (eg. npx @qaecy/cue-cli sync --help)

Sync a folder

To sync the current dir to the space with id <space-id> under the provider id d_drive (provider id is used to distinguish different document sources and if none is provided the default provider is used). The v-flag is for verbose logging so we can follow the progress.

npx @qaecy/cue-cli sync -s <space-id> -p . --provider d_drive -v

Sync command options

| Option | Description | Default | |-----------------------|------------------------------------------------------------------------------------------------------|--------------| | -s, --space <id> | Specify the space ID (required) | N/A | | -p, --path <id> | Specify the folder path to sync (required) | N/A | | -k, --key <api-key> | Specify the API key (or set CUE_API_KEY env variable) | N/A | | --provider <id> | Specify the provider ID (e.g., sharepoint, drive, dropbox). Leave empty for default provider | "" | | -v, --verbose | Enable verbose output | false | | -e, --emulators | Use emulators for sync | false | | -z, --zip | Include zipped content. Will be unzipped to <zip_path>_unzipped. Max uncompressed size: 500 MB, max recursion depth: 3. Cleans up unzipped files after sync. | false | | --legacy | Write RDF metadata as serialised Turtle BLOBs to the processed storage bucket instead of patching the knowledge graph directly. Use this when the ledger and graph services are not yet available for the target environment. | false | | --metadata-only | Push filesystem-structure metadata for every local file directly to the commands API, without checking what is already on the remote, running a credit estimate, or uploading any file content. Useful for repairing missing graph metadata after a migration or interrupted sync. Can be combined with --legacy to write the metadata as BLOBs. | false |

util-remove-rdf-star

Remove RDF-star (quoted triple) statements from an NQuads file. Supports both plain .nq and gzipped .nq.gz files. If the input is gzipped the output will also be gzipped.

npx @qaecy/cue-cli util-remove-rdf-star -i <input.nq.gz> -o <output.nq.gz> -v

Options

| Option | Description | Default | |----------------------|-----------------------------------------|---------| | -i, --input <path> | Input file path (.nq or .nq.gz) (required) | N/A | | -o, --output <path>| Output file path (.nq or .nq.gz) (required) | N/A | | -v, --verbose | Enable verbose output | false |