Skip to content

Commit

Permalink
update names
Browse files Browse the repository at this point in the history
  • Loading branch information
coffee-cup committed Feb 4, 2025
1 parent 05d010c commit 3d759b0
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 9 deletions.
2 changes: 1 addition & 1 deletion cli/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var BuildCommand = &cli.Command{
Usage: "Show the build plan before building. This is useful for development and debugging.",
Value: false,
},
}, commonFlags()...),
}, commonPlanFlags()...),
Action: func(ctx context.Context, cmd *cli.Command) error {
buildResult, app, env, err := GenerateBuildResultForCommand(cmd)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion cli/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"github.com/urfave/cli/v3"
)

func commonFlags() []cli.Flag {
func commonPlanFlags() []cli.Flag {
return []cli.Flag{
&cli.StringSliceFlag{
Name: "env",
Expand Down
2 changes: 1 addition & 1 deletion cli/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ var InfoCommand = &cli.Command{
Name: "out",
Usage: "output file name",
},
}, commonFlags()...),
}, commonPlanFlags()...),
Action: func(ctx context.Context, cmd *cli.Command) error {
buildResult, _, _, err := GenerateBuildResultForCommand(cmd)
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion cli/plan.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ var PlanCommand = &cli.Command{
Aliases: []string{"o"},
Usage: "output file name",
},
}, commonFlags()...),
}, commonPlanFlags()...),
Action: func(ctx context.Context, cmd *cli.Command) error {
buildResult, _, _, err := GenerateBuildResultForCommand(cmd)
if err != nil {
Expand Down
18 changes: 13 additions & 5 deletions docs/src/content/docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ The following options are available across multiple commands:

### build

Build a project using Railpack. This command takes a directory as input and builds a container image using BuildKit.
Build a project using Railpack. This command takes a directory as input and
builds a container image using BuildKit.

**Usage:**

Expand All @@ -39,7 +40,8 @@ railpack build [options] DIRECTORY

### plan

Generate and view build plans for a project. This command analyzes a directory and outputs the build plan that would be used.
Generate and view build plans for a project. This command analyzes a directory
and outputs the build plan that would be used.

**Usage:**

Expand All @@ -55,7 +57,9 @@ railpack plan [options] DIRECTORY

### info

View detailed information about a project. This command analyzes a directory and provides information about the detected configuration, dependencies, and build requirements.
View detailed information about a project. This command analyzes a directory and
provides information about the detected configuration, dependencies, and build
requirements.

**Usage:**

Expand All @@ -72,7 +76,10 @@ railpack info [options] DIRECTORY

### schema

Output the JSON schema for the Railpack configuration file. This command outputs the schema that defines the structure of valid Railpack configuration files. The schema can be used by IDEs and other tools for providing autocompletion and validation.
Output the JSON schema for the Railpack configuration file. This command outputs
the schema that defines the structure of valid Railpack configuration files. The
schema can be used by IDEs and other tools for providing autocompletion and
validation.

**Usage:**

Expand All @@ -82,7 +89,8 @@ railpack schema

### frontend

Start the BuildKit GRPC frontend server. This command is typically used internally by the build system.
Start the BuildKit GRPC frontend server. This command is typically used
internally by the build system.

**Usage:**

Expand Down

0 comments on commit 3d759b0

Please sign in to comment.