Fiftyone Develop Plugin

2. Plan before implementing

Present file structure and design. Get user approval before generating code.

3. Search existing plugins for patterns

list_plugins(enabled=True)
list_operators(builtin_only=False)
get_operator_schema(operator_uri="@voxel51/brain/compute_similarity")

4. Test locally before done

Install plugin and verify it works in FiftyOne App.

5. Iterate on feedback

Refine until the plugin works as expected.

Workflow

Phase 1: Requirements

Ask these questions:

1. "What should your plugin do?" (one sentence)
2. "Operator (action) or Panel (interactive UI)?"
3. "What inputs from the user?"
4. "What outputs/results?"
5. "External APIs or secrets needed?"
6. "Background execution for long tasks?"

Phase 2: Design

1. Search existing plugins for similar patterns
2. Create plan with:
   • Plugin name (@org/plugin-name)
   • File structure
   • Operator/panel specs
   • Input/output definitions
3. Get user approval before coding

See PLUGIN-STRUCTURE.md for file formats.

Phase 3: Generate Code

Create these files:

Reference docs:

• PYTHON-OPERATOR.md
• PYTHON-PANEL.md
• JAVASCRIPT-PANEL.md

Phase 4: Install & Test

# Find plugins directory
python -c "import fiftyone as fo; print(fo.config.plugins_dir)"

# Copy plugin
cp -r ./my-plugin ~/.fiftyone/plugins/

# Verify detection
python -c "import fiftyone as fo; print(fo.plugins.list_plugins())"

Test in App:

launch_app(dataset_name="test-dataset")
# Press Cmd/Ctrl + ` to open operator browser
# Search for your operator

Phase 5: Iterate

1. Get user feedback
2. Fix issues
3. Re-copy to plugins directory
4. Restart App if needed
5. Repeat until working

Quick Reference

Plugin Types

Operator Config Options

Input Types

Minimal Example

fiftyone.yml: