Skip to content

Commit

Permalink
docs: add expected output behavior of -- plan
Browse files Browse the repository at this point in the history
  • Loading branch information
CoderJoshDK committed Dec 29, 2024
1 parent e907bb8 commit e745975
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/pages/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ nixpacks plan examples/node
```

By default, the plan is output in JSON format. You can output in TOML format with the `--format toml` option.
The generated plan will be outputted to stdout, while some providers expose recoverable errors to stderr.

View all plan options with

Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ struct Args {
#[derive(Subcommand)]
enum Commands {
/// Generate a build plan for an app.
/// Generated plan will be outputted to stdin, while warnings might be outputted to stderr.
/// Generated plan will be outputted to stdout, while warnings might be outputted to stderr.
Plan {
/// App source
path: String,
Expand Down

0 comments on commit e745975

Please sign in to comment.