Skip to content

feat(cli) add --format= option to list command#407

Merged
theskumar merged 6 commits intotheskumar:masterfrom
sammck:master
Jul 23, 2022
Merged

feat(cli) add --format= option to list command#407
theskumar merged 6 commits intotheskumar:masterfrom
sammck:master

Conversation

@sammck
Copy link
Copy Markdown
Contributor

@sammck sammck commented May 19, 2022

The default is simple, which is backwards compatible.
--format=json will display the list as a json dict

resolves #405

sammck added 2 commits May 19, 2022 13:12
The default is simple, which is backwards compatible.
--format=json will display the list as a json dict

resolves theskumar#405
Allows dumping of all variables in various formats.

Currently defined formats:
   simple:  Each variable is output as <name>=<value> with no
            quoting or escaping. The output is not parseable. This
            is the default format, for backwards compatibility.
   shell:   Each variable is output as <name>=<value>, where
            <value> is quoted/escaped with shell-compatible rules,
            the result may be imported into a shell script with
              eval "$(dotenv list --format=shell)"
   export:  Similar to "shell", but prefixes each line with "export ",
            so that when imported into a shell script, the variables
            are exported.
   json:    The entire set of variables is output as a JSON-serialized
            object
@sammck sammck changed the title feat(cli) add --format=(simple,json) option to list command feat(cli) add --format= option to list command May 20, 2022
Comment thread src/dotenv/cli.py Outdated
Comment thread src/dotenv/cli.py
sammck and others added 2 commits May 20, 2022 11:01
dotenv_as_dict has Optional[str] values. 'None' values cannot be represented in shell-formatted listings, so they are omitted.
Comment thread tests/test_cli.py Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--format= option for CLI list command

2 participants