Skip to content

Commit a7cf8bd

Browse files
fix: minor updates to the --help (#85)
1 parent 1efdf7e commit a7cf8bd

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

messages/deploy.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
11
# summary
2-
2+
33
Deploy a project interactively to any Salesforce environment.
44

55
# description
66

7-
The command first analyzes your project, active or logged-into environments, and local defaults to determine what to deploy and where. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.
7+
This command must be run from within a project.
88

9-
For example, if your local project contains a package directory with metadata source files, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. If the command finds Apex tests, it asks if you want to run them and at which level.
9+
The command first analyzes your project, your active or logged-into environments, and local defaults to determine what to deploy and where to deploy it. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.
1010

11-
Similarly, if the command finds a local functions directory, the command prompts if you want to deploy it and to which compute environment. The command prompts and connects you to a compute environment of your choice if you’re not currently connected to any.
11+
For example, if your local project contains a source directory with metadata files in source format, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. If the command finds Apex tests, it asks if you want to run them and at which level.
1212

13-
This command must be run from within a project.
13+
Similarly, if the command finds a local functions directory, the command prompts if you want to deploy it and to which compute environment. The command prompts and connects you to a compute environment of your choice if you’re not currently connected to any.
1414

1515
The command stores your responses in a local file and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.
1616

1717
Use this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as "sf project deploy org", that provide additional flags.
1818

1919
# examples
2020

21-
- <%= config.bin %> <%= command.id %>
21+
- Deploy a project and use stored values from a previous command run:
22+
23+
<%= config.bin %> <%= command.id %>
24+
25+
- Reprompt for all deployment inputs:
26+
27+
<%= config.bin %> <%= command.id %> --interactive
2228

2329
# flags.interactive.summary
2430

0 commit comments

Comments
 (0)