CLI Reference

pxt --help
pxt health

pxt <command> [args...]

# inspect
pxt ls -l                          # everything under root, with metadata
pxt ls some_dir --counts           # row counts (parallelized)
pxt describe my_dir/my_table       # schema
pxt rows my_dir/my_table -n 5      # first 5 stored cells

# query
pxt get my_dir/my_table 42         # PK lookup
pxt count my_dir/my_table          # row count
pxt errors my_dir/my_table         # rows where a computed column failed

# ops
pxt drop my_dir/my_table -f
pxt mv my_dir/my_table other_dir
pxt revert my_dir/my_table --steps 3 -f

# interactive
pxt shell

# serve & deploy
pxt serve my-service --config service.toml
pxt deploy production

pxt ls                            # root
pxt ls some_dir                   # contents of some_dir
pxt ls -l some_dir                # with metadata
pxt ls --counts                   # with row counts

path                kind   cols  version  flags
agent_demo          dir                       -
audio_chunks        view      9        3  ci
chess_vids          table     3        3  ci
chk                 table     2        1  i

pxt describe my_dir/my_table
pxt describe my_dir/my_table --json

pxt columns                       # every column in the catalog
pxt columns my_dir/my_table       # one table
pxt columns my_dir                # every table under a directory, recursively
pxt columns pxt://org:db          # every table in a hosted database
pxt columns --computed            # computed columns across every table
pxt computed                      # same as above

pxt idxs                          # every index
pxt idxs my_dir/my_table          # indexes on one table
pxt idxs my_dir                   # every table under a directory, recursively
pxt idxs pxt://org:db             # every table in a hosted database
pxt idxs --embedding              # only embedding indexes

pxt history my_dir/my_table
pxt history my_dir/my_table -n 5  # last 5 versions

pxt status
pxt status --sizes --json

pxt config
pxt config --section openai
pxt config --source env

pxt rows my_dir/my_table -n 3
pxt rows my_dir/my_table --cols id,text,score

pxt get my_dir/my_table 42                    # single-column PK, int
pxt get my_dir/my_table some_string_id        # single-column PK, string
pxt get my_dir/my_table 42 abc                # composite PK, in declared order
pxt get my_dir/my_table 42 --cols id,text     # restrict to listed columns

pxt count my_dir/my_table         # prints the integer
pxt count my_dir/my_table --json

pxt errors my_dir/my_table
pxt errors my_dir/my_table --col embedding

pxt drop my_dir/my_table -f                 # drop a table
pxt drop my_dir/my_table --cascade -f       # also drop dependent views
pxt drop my_dir/my_table -n                 # dry-run

pxt rm my_dir -f                  # remove an empty directory
pxt rm my_dir -r -f               # recursive: also remove contained tables/subdirs

pxt rename my_dir/old_name new_name

pxt mv my_dir/my_table other_dir              # -> other_dir/my_table
pxt mv my_dir/my_table /                      # move to root

pxt revert my_dir/my_table -f                 # undo the last op
pxt revert my_dir/my_table --steps 3 -f       # roll back 3 versions

$ pxt shell
pxt> ls
path                kind
agent_demo          dir
chess_vids          table
...
pxt> describe chess_vids
...
pxt> exit

pxt ls --json | jq '.entries[] | select(.kind == "table")'
pxt get my_dir/my_table 42 --json | jq '.row'
pxt count my_dir/my_table --json | jq '.count'

# service.toml
[[service]]
name = "my-service"
port = 8000

[[service.routes]]
type = "insert"
table = "my_dir/my_table"
path = "/generate"
inputs = ["prompt"]
outputs = ["prompt", "result"]

[[service.routes]]
type = "query"
path = "/search"
query = "myapp.queries.search_docs"

pxt serve my-service --config service.toml

pxt serve insert --table my_dir.my_table --path /generate \
  --inputs prompt --outputs prompt result --port 8000

pxt serve query --query myapp.queries.search_docs --path /search

{"status": "started", "host": "0.0.0.0", "port": 8000, "url": "http://localhost:8000", "docs_url": "http://localhost:8000/docs", "routes": 2}

{"status": "error", "code": "EADDRINUSE", "port": 8000, "message": "port 8000 is already in use"}

pxt serve my-service --config service.toml --dry-run --json

pxt serve insert --table my_dir.my_table --path /generate \
  --inputs prompt --outputs prompt result --port 8000

curl -X POST http://localhost:8000/generate \
  -H 'Content-Type: application/json' \
  -d '{"prompt": "a sunset over the ocean"}'

pxt serve update --table my_dir.my_table --path /update \
  --inputs prompt --outputs id prompt result

pxt serve delete --table my_dir.my_table --path /delete

pxt serve query --query myapp.queries.search_docs --path /search

pxt serve query --query myapp.queries.lookup_by_id --path /lookup \
  --one-row --method get

pxt serve insert --table my_dir.my_table --path /generate \
  --inputs prompt --outputs prompt result \
  --export-sql-db-connect 'postgresql+psycopg://user:pw@host/analytics' \
  --export-sql-table generations

pxt deploy <env>

pxt serve my-service --config service.toml --dry-run

pxt serve my-service --config service.toml --port 9000

pxt serve insert --table my_dir.images --path /resize \
  --inputs width height --uploadfile-inputs image \
  --outputs resized --return-fileresponse

curl -X POST http://localhost:8000/resize \
  -F [email protected] -F width=640 -F height=480 \
  --output resized.jpg

pxt serve insert --table my_dir.videos --path /ingest --background

{"id": "abc123", "job_url": "http://localhost:8000/jobs/abc123"}