You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently the forc default output is huge, not nice to view in smaller screens. I think we should have the examples section under --examples type of flag rather than showing them by default
Current output:
Fuel OrchestratorUsage: forc [OPTIONS] <COMMAND>Commands: addr2line Show location and context of an opcode address in its source file build Compile the current or target project [aliases: b] check Check the current or target project and all of its dependencies for errors clean Removes the default forc compiler output artifact directory, i.e. `<project-name>/out` completions Generate tab-completion scripts for your shell new Create a new Forc project at `<path>` init Create a new Forc project in an existing directory parse-bytecode Parse bytecode file into a debug format test Run the Sway unit tests for the current project [aliases: t] update Update dependencies in the Forc dependencies directory plugins List all forc plugins template Create a new Forc project from a git template contract-id Determine contract-id for a contract. For workspaces outputs all contract ids in the workspace predicate-root Determine predicate-root for a predicate. For workspaces outputs all predicate roots in the workspace help Print this message or the help of the given subcommand(s)Options: -v, --verbose... Use verbose output -s, --silent Silence all output -L, --log-level <LOG_LEVEL> Set the log level -h, --help Print help -V, --version Print versionExamples: # List all plugins forc plugins # List all plugins with their paths forc plugins --paths # List all plugins with their descriptions forc plugins --describe # List all plugins with their paths and descriptions forc plugins --paths --describe # Run test forc test # Run test with a filter forc test $filter # Run test without any output forc test --silent # Run test without creating or update the lock file forc test --locked # Compile the current projectx forc build # Compile the current project from a different path forc build --path <PATH> # Compile the current project without updating dependencies forc build --path <PATH> --locked # Check the current project forc check # Check the current project with a different path forc check --path <PATH> # Check the current project without updating dependencies forc check --locked
The text was updated successfully, but these errors were encountered:
kayagokalp
changed the title
Hide examples section of forc help message under a --help
Hide examples section of forc help message, only show them with a flag
May 14, 2024
## Description
closes#6005.
As stated in the issue, executing `forc` prints huge output with
examples etc. This is not ideal because it is very hard to navigate to
list of commands especially with smaller screens. This PR changes the
behavor such that executing just `forc` will print:
```console
Fuel Orchestrator
Usage: forc [OPTIONS] <COMMAND>
Commands:
addr2line Show location and context of an opcode address in its source file
build Compile the current or target project [aliases: b]
check Check the current or target project and all of its dependencies for errors
clean Removes the default forc compiler output artifact directory, i.e. `<project-name>/out`
completions Generate tab-completion scripts for your shell
new Create a new Forc project at `<path>`
init Create a new Forc project in an existing directory
parse-bytecode Parse bytecode file into a debug format
test Run the Sway unit tests for the current project [aliases: t]
update Update dependencies in the Forc dependencies directory
plugins List all forc plugins
template Create a new Forc project from a git template
contract-id Determine contract-id for a contract. For workspaces outputs all contract ids in the workspace
predicate-root Determine predicate-root for a predicate. For workspaces outputs all predicate roots in the workspace
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose... Use verbose output
-s, --silent Silence all output
-L, --log-level <LOG_LEVEL> Set the log level
-h, --help Print help (see more with '--help')
-V, --version Print version
```
with `--help` flag we still show the examples etc.
Currently the forc default output is huge, not nice to view in smaller screens. I think we should have the examples section under --examples type of flag rather than showing them by default
Current output:
The text was updated successfully, but these errors were encountered: