# osprofiler.cmd package

## Submodules

## osprofiler.cmd.cliutils module

osprofiler.cmd.cliutils.add_arg(func, *args, **kwargs)

  Bind CLI arguments to a shell.py do_foo function.

osprofiler.cmd.cliutils.arg(*args, **kwargs)

  Decorator for CLI args.

  Example:

      >>> @arg("name", help="Name of the new entity")
          ... def entity_create(args):
          ... pass

osprofiler.cmd.cliutils.env(*args, **kwargs)

  Returns the first environment variable set.

  If all are empty, defaults to ‘’ or keyword arg default.

## osprofiler.cmd.commands module

class osprofiler.cmd.commands.BaseCommand

  Bases: `object`

  group_name = None

class osprofiler.cmd.commands.TraceCommands

  Bases: `BaseCommand`

  group_name = 'trace'
  list(args)

    List all traces

  show(args)

    Display trace results in HTML, JSON or DOT format.

## osprofiler.cmd.shell module

Command-line interface to the OpenStack Profiler.

class osprofiler.cmd.shell.OSProfilerShell(argv)

  Bases: `object`

osprofiler.cmd.shell.main(args=None)

## Module contents

this page last updated: 2026-03-27 00:00:00

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug