# tmuxp.cli.ls.LS_DESCRIPTION

- **Module:** tmuxp.cli.ls
- **Package:** tmuxp
- **Language:** Python
- **Kind:** constant
- **Source:** https://github.com/tmux-python/tmuxp/blob/153acdf6ff1268b14d3d03ed488f545a7123c8f1/src/tmuxp/cli/ls.py#L52
- **Page:** https://libtmux.org/en/py/stable/workspace/reference/tmuxp-cli-ls-ls_description/

```py
tmuxp.cli.ls.LS_DESCRIPTION = build_description(
    """
    List workspace files in the tmuxp configuration directory.
    """,
    (
        (
            None,
            [
                "tmuxp ls",
                "tmuxp ls --tree",
                "tmuxp ls --full",
            ],
        ),
        (
            "Machine-readable output examples",
            [
                "tmuxp ls --json",
                "tmuxp ls --json --full",
                "tmuxp ls --ndjson",
                "tmuxp ls --json | jq '.workspaces[].name'",
            ],
        ),
    ),
)
```