Species in the CLI

Browse species

brainmaps species list
brainmaps species get "house mouse"

Replace the example with the exact common name returned by the list command. Although the current CLI argument help calls this an ID, the API detail route looks up species by common name, not numeric ID, slug or scientific name.

The list includes numeric IDs. Use those IDs for brain filtering and species associations:

brainmaps brain list --species 1

Replace 1 with your species’ actual ID; IDs are installation-specific.

Current search limitation

brainmaps species search QUERY exists, but the current species API does not apply its search parameter. Its result can include unrelated species. Use the list and select the exact name or ID until server-side species search is implemented.

Add a species

The CLI has no species-create command. Sign in and use Add a species, reached from the Categories page. Choose an existing category and provide the common and scientific names.

The API also accepts POST /api/species/ with name, scientific_name, optional description, and category_id. Any active signed-in user can create a species. Only the superadmin can edit or delete an existing species or change categories. See API endpoints.