Environment Commands (owl env)

Tools for managing OWA environment plugins - modular components that capture desktop data.

Command Reference

owl env

Environment plugin management commands.

Usage:

owl env [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--install-completion	boolean	Install completion for the current shell.	None
--show-completion	boolean	Show completion for the current shell, to copy it or customize the installation.	None
--help	boolean	Show this message and exit.	False

owl env docs

Manage plugin documentation - validate quality and show statistics.

This command provides comprehensive documentation management for plugins, including validation for CI/CD integration and statistics for development.

Usage:

owl env docs [OPTIONS] [PLUGIN_NAMESPACE]

Options:

Name	Type	Description	Default
--validate	boolean	Validate plugin documentation	False
--strict	boolean	Enable strict mode (100% coverage + 100% quality)	False
--min-coverage-pass	float	Minimum coverage for PASS status	0.8
--min-coverage-fail	float	Minimum coverage to avoid FAIL status	0.6
--min-quality-pass	float	Minimum good quality ratio for PASS status	0.6
--min-quality-fail	float	Minimum good quality ratio to avoid FAIL status	0.0
--output-format	text	Output format: text or json	text
--by-type	boolean	Group statistics by component type	False
--help	boolean	Show this message and exit.	False

owl env list

List environment plugins and components.

Usage:

owl env list [OPTIONS] [NAMESPACES]...

Options:

Name	Type	Description	Default
--components, -c	boolean	Show individual components	False
--details, -d	boolean	Show import paths and load status	False
--table	boolean	Display in table format	False
--type, -t	text	Filter by component type (callables/listeners/runnables)	None
--search, -s	text	Search components by name pattern	None
--inspect	text	Inspect specific component (show docstring/signature)	None
--help	boolean	Show this message and exit.	False

owl env search

Search for components across all plugins using pattern matching.

Usage:

owl env search [OPTIONS] PATTERN

Options:

Name	Type	Description	Default
--type, -t	text	Filter by component type	None
--namespace, -n	text	Filter by namespace	None
--case-sensitive, -c	boolean	Case sensitive search	False
--details, -d	boolean	Show detailed component information	False
--table	boolean	Display results in table format	False
--limit, -l	integer	Limit number of results	50
--help	boolean	Show this message and exit.	False

owl env stats

Show comprehensive statistics about the plugin ecosystem.

Usage:

owl env stats [OPTIONS]

Options:

Name	Type	Description	Default
--detailed, -d	boolean	Show detailed statistics	False
--by-namespace, -n	boolean	Group statistics by namespace	False
--by-type, -t	boolean	Group statistics by component type	False
--loaded-only, -l	boolean	Show statistics for loaded components only	False
--namespaces	boolean	Show available namespaces	False
--help	boolean	Show this message and exit.	False

owl env validate

Validate a plugin specification from YAML file or entry point.

This command can validate plugin specifications in two ways:

1. From YAML files: owl env validate ./plugin.yaml
2. From entry points: owl env validate owa.env.plugins.desktop:plugin_spec

The command automatically detects the input type and validates accordingly.

Usage:

owl env validate [OPTIONS] SPEC_INPUT

Options:

Name	Type	Description	Default
--check-imports / --no-check-imports	boolean	Validate that component import paths are accessible	True
--verbose, -v	boolean	Show detailed validation information	False
--help	boolean	Show this message and exit.	False

Related Documentation

• Environment Guide - Environment system overview
• Custom EnvPlugins - Creating custom plugins
• CLI Tools - Complete CLI overview