Search commands

Find scenes by name and description, and manage what semantic search knows.

Preview

Keyword search stays in Puni; semantic search sends text to Voyage only when you say so. Read Scenes and the library for search in the studio.

puni searchFind scenes by name and description, and manage what semantic search knows.

Command	What it does
`puni search keyword`	Search names and descriptions without leaving Puni.
`puni search semantic`	Send the query to Voyage and rank the descriptions you indexed.
`puni search preview`	Show the exact text indexing would send, and its content hash.
`puni search index`	Send the previewed text to Voyage.
`puni search unindex`	Remove the embedding; keep the scene and keyword search.
`puni search refresh`	Rebuild a page of the keyword index for older scenes. Repeat until done.

#`search keyword`

Search names and descriptions without leaving Puni.

puni search keyword --query text [--limit 10 --reusable] --base-url https://puni.design

Flag	Type	Default	What it does
`--query` required	`string`		1 to 256 characters.
`--limit`	`number`	`10`	1 to 25 results.
`--reusable`	`boolean`	`false`	Only reusable objects.
`--base-url`	`string`		The studio origin, such as https://puni.design. Defaults to PUNI_BASE_URL, else the one studio you are signed in to. HTTPS, except loopback.
`--auth-file`	`string`		Read and write credentials in this file instead of ~/.config/puni/credentials.json.
`--json`	`boolean`	`false`	Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
`--help` `-h`	`boolean`		Print the command list.

#Run `search keyword`

puni search keyword --query 'amber lamp' --base-url https://puni.design --json

#`search semantic`

Send the query to Voyage and rank the descriptions you indexed.

puni search semantic --query text [--limit 10 --reusable] --base-url https://puni.design

Flag	Type	Default	What it does
`--query` required	`string`		1 to 256 characters.
`--limit`	`number`	`10`	1 to 25 results.
`--reusable`	`boolean`	`false`	Only reusable objects.
`--base-url`	`string`		The studio origin, such as https://puni.design. Defaults to PUNI_BASE_URL, else the one studio you are signed in to. HTTPS, except loopback.
`--auth-file`	`string`		Read and write credentials in this file instead of ~/.config/puni/credentials.json.
`--json`	`boolean`	`false`	Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
`--help` `-h`	`boolean`		Print the command list.

#Run `search semantic`

puni search semantic --query 'warm desk lighting' --base-url https://puni.design --json

#`search preview`

Show the exact text indexing would send, and its content hash.

puni search preview PROJECT_ID --revision N --base-url https://puni.design

Flag	Type	Default	What it does
`--revision` required	`number`		The saved revision.
`--base-url`	`string`		The studio origin, such as https://puni.design. Defaults to PUNI_BASE_URL, else the one studio you are signed in to. HTTPS, except loopback.
`--auth-file`	`string`		Read and write credentials in this file instead of ~/.config/puni/credentials.json.
`--json`	`boolean`	`false`	Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
`--help` `-h`	`boolean`		Print the command list.

#Run `search preview`

puni search preview amber-lamp --revision 3 --base-url https://puni.design --json

#`search index`

Send the previewed text to Voyage.

puni search index PROJECT_ID --revision N --base-url https://puni.design

Flag	Type	Default	What it does
`--revision` required	`number`		The saved revision.
`--base-url`	`string`		The studio origin, such as https://puni.design. Defaults to PUNI_BASE_URL, else the one studio you are signed in to. HTTPS, except loopback.
`--auth-file`	`string`		Read and write credentials in this file instead of ~/.config/puni/credentials.json.
`--json`	`boolean`	`false`	Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
`--help` `-h`	`boolean`		Print the command list.

#Run `search index`

puni search index amber-lamp --revision 3 --base-url https://puni.design --json

#`search unindex`

Remove the embedding; keep the scene and keyword search.

puni search unindex PROJECT_ID --revision N --base-url https://puni.design

Flag	Type	Default	What it does
`--revision` required	`number`		The saved revision.
`--base-url`	`string`		The studio origin, such as https://puni.design. Defaults to PUNI_BASE_URL, else the one studio you are signed in to. HTTPS, except loopback.
`--auth-file`	`string`		Read and write credentials in this file instead of ~/.config/puni/credentials.json.
`--json`	`boolean`	`false`	Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
`--help` `-h`	`boolean`		Print the command list.

#Run `search unindex`

puni search unindex amber-lamp --revision 3 --base-url https://puni.design --json

#`search refresh`

Rebuild a page of the keyword index for older scenes. Repeat until done.

puni search refresh [--cursor next] --base-url https://puni.design

Flag	Type	Default	What it does
`--cursor`	`string`		Continue from a previous page.
`--base-url`	`string`		The studio origin, such as https://puni.design. Defaults to PUNI_BASE_URL, else the one studio you are signed in to. HTTPS, except loopback.
`--auth-file`	`string`		Read and write credentials in this file instead of ~/.config/puni/credentials.json.
`--json`	`boolean`	`false`	Answer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
`--help` `-h`	`boolean`		Print the command list.

#Run `search refresh`

puni search refresh --base-url https://puni.design --json

Back to the command line index for every group.

Was this useful?

#search keyword

#Run search keyword

#search semantic

#Run search semantic

#search preview

#Run search preview

#search index

#Run search index

#search unindex

#Run search unindex

#search refresh

#Run search refresh