VoidscapeDocs
Current main
On this page Overview
Start here

Quick start

Complete one read from source inspection to a citation-grounded answer. Run every command from any terminal and keep each decision visible.

If Voidscape is not ready yet, see Install.

Choose one source#

Use a local image, audio file, video, folder, or supported public URL you are allowed to process. The examples below use meeting.mp4; replace that name with your path or URL.

Inspect the source#

PowerShell
voidscape inspect "meeting.mp4"

Inspect reports source facts such as duration, dimensions, audio, and available caption or sidecar paths. It does not extract frames, transcribe speech, or upload the source.

Preview the decision#

PowerShell
voidscape preview "meeting.mp4"

Read the preview before continuing. Check the evidence scope, dependencies, estimated agent-reading cost, and these independent fields:

FieldMeaning
requires_cloud_approvalAudio would leave the host for this job
needs_model_downloadA selected local model is not present yet
needs_installA required local dependency is missing
freeThe selected evidence-preparation path has no out-of-pocket backend cost

If the preview requires a cloud or model-download approval, stop and make that decision for this source. Do not copy approval flags from this guide.

Read the evidence#

Use a new work folder:

PowerShell
voidscape read "meeting.mp4" --workdir voidscape-output

The read prepares manifest.json, selected frames/, and transcript.txt. It does not write the final interpretation for the agent.

Ask one grounded question#

Give the work folder to your agent and ask:

Open the cited transcript or frame and verify at least one statement yourself. The citation points to source evidence; it is not a guarantee that transcription or interpretation is perfect.

Try your own source#

Replace the example path with another source you are allowed to use. Run inspect and preview again; approvals belong to the current source, scope, tier, and backend. Use a fresh workdir for the read.

For images, articles, feeds, URLs, time windows, or raw JSON envelopes, continue with Workflow and protocol and the focused reader pages.

Where next#

Edit this page on GitHub ↗