Skip to main content
The run command starts the API server that serves your datasets, dashboards, and other routes. This runs the API server in standalone mode, which automatically mounts the project at the /analytics/{project_name}/v{project_version} route. For details on how to mount the Squirrels APIs into an existing FastAPI application, see this how-to guide.

​
Usage

​
Options

In addition to the global options, this command supports the following options:

​
Examples

Start the server:
Build first, then start:
Run on all interfaces and a custom port:

​
Notes

  • The --build option can be useful for deployment processes. Outside of deployment, avoid using it if there are no changes to the sources, seeds, or build models.
  • Use the following environment variable settings to control the caching behavior.
    • SQRL_PARAMETERS__CACHE_SIZE
    • SQRL_PARAMETERS__CACHE_TTL_MINUTES
    • SQRL_DATASETS__CACHE_SIZE
    • SQRL_DATASETS__CACHE_TTL_MINUTES
    • SQRL_DASHBOARDS__CACHE_SIZE
    • SQRL_DASHBOARDS__CACHE_TTL_MINUTES