Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.runloop.ai/llms.txt

Use this file to discover all available pages before exploring further.

Start with the Runloop Quickstart to use the examples below.
When working with hundreds or thousands of Devboxes, effective organization becomes crucial. Runloop provides a powerful metadata system to help you tag, categorize, and filter your Devboxes efficiently.

​
Using Metadata

Metadata allows you to attach custom key-value pairs to your Devboxes. This information can include:
  • Project names
  • Team assignments
  • Environment types (e.g., development, staging, production)
  • Any other relevant tags for your workflow

​
Adding Metadata to Devboxes

When creating a Devbox, you can include metadata to help organize and filter them later: 
devbox = await runloop.devbox.create(
    metadata={
        "project": "runloop-fe",
        "team": "frontend",
        "environment": "development"
    }
)
print(f"Devbox created with ID: {devbox.id}")

​
Benefits of Using Metadata

  1. Easy Filtering: Quickly find Devboxes related to specific projects or teams.
  2. Improved Organization: Group Devboxes logically based on your workflow.
  3. Enhanced Visibility: Easily identify the purpose and ownership of each Devbox.
  4. Streamlined Management: Perform bulk operations on Devboxes with similar metadata.

​
Viewing and Filtering Metadata

The Runloop dashboard displays metadata tags for each Devbox, allowing you to:
  • View all metadata associated with a Devbox at a glance
  • Use integrated filters to sort and find Devboxes based on their metadata
  • Create custom views based on frequently used metadata filters

​
Best Practices for Using Metadata

  1. Consistent Naming: Use a consistent naming convention for your metadata keys and values.
  2. Relevant Information: Include only metadata that is useful for organizing and filtering.
  3. Update Regularly: Keep metadata up-to-date as projects evolve or team assignments change.
  4. Use Hierarchies: Consider using hierarchical metadata (e.g., “env:production” instead of just “production”).
By effectively using metadata, you can maintain organization and clarity even when managing thousands of Devboxes across multiple projects and teams.