​
Agent interaction

Once you have your agents, config, and data configured, you can ask this agent questions by running oxy run path/to/agent.agent.yml "<prompt>", as shown below:

oxy run path/to/agent.agent.yml "How many users do we have?"

​
Database Synchronization

The sync command collects semantic information from your databases, making their structure available to your agents.

Basic usage:

oxy sync

Sync a specific database:

oxy sync database_name

Sync specific datasets within a database:

oxy sync database_name -d dataset1

By default, files that already exist will be skipped. To overwrite existing files:

oxy sync --overwrite
# or oxy sync -o (shorthand)

To overwrite existing files for a specific database:

oxy sync database_name --overwrite

The sync command will show warnings when files are skipped (already exist) or when files are overwritten (when using the -o flag).

For more detailed information about database synchronization, see the Database Sync documentation.

​
Run queries

Run a raw query on target database

oxy run example_monthly_rejected.sql --database=primary_database

Run a query rendered from a Jinja template

oxy run example_weekly_rejected.sql --database=primary_database -v variable_a=1 variable_b=a variable_c=\*

​
Workflow usage

To execute a workflow, you can run:

oxy run path/to/workflow_name.workflow.yml

​
Embedding management

To embed files from into a local vector store you can use oxy build. We’re downloading our models from huggingface hub so you may need to login using:

huggingface-cli login

or simply copy your plaintext token into $HOME/.cache/huggingface/token file, then run oxy build to index the data.

oxy build

The generated embeddings can be verified using

oxy vec-search "Hello Embedding"