Skip to content

Commit

Permalink
update command output (#1245)
Browse files Browse the repository at this point in the history
Co-authored-by: mattsse <[email protected]>
  • Loading branch information
github-actions[bot] and mattsse authored Jul 21, 2024
1 parent 9e09a3a commit caeec39
Show file tree
Hide file tree
Showing 22 changed files with 70 additions and 53 deletions.
2 changes: 1 addition & 1 deletion src/output/cast/cast-call

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes-expectrevert

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes-tracing

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/cheatcodes/forge-test-simple

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/deps/forge-install

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/foundry-template/forge-build

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/foundry-template/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions src/output/fuzz_testing/forge-test-fail-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/fuzz_testing/forge-test-no-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/fuzz_testing/forge-test-success-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/hello_foundry/forge-build

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/hello_foundry/forge-init

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/hello_foundry/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/nft_tutorial/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/test_filters/forge-test-match-contract-and-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/test_filters/forge-test-match-path

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/reference/cli/cast.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Commands:
--format-bytes32-string]
from-bin Convert binary data into hex data [aliases: --from-bin, from-binx, fb]
from-fixed-point Convert a fixed point number into an integer [aliases: --from-fix, ff]
from-rlp Decodes RLP encoded data [aliases: --from-rlp]
from-rlp Decodes RLP hex-encoded data [aliases: --from-rlp]
from-utf8 Convert UTF8 text to hex [aliases: --from-ascii, --from-utf8,
from-ascii, fu, fa]
from-wei Convert wei into an ETH amount [aliases: --from-wei, fw]
Expand Down
8 changes: 3 additions & 5 deletions src/reference/cli/cast/from-rlp.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
# cast from-rlp

Decodes RLP encoded data.
Decodes RLP hex-encoded data

```bash
$ cast from-rlp --help
Usage: cast from-rlp [VALUE]

Arguments:
[VALUE]
The value to convert
[VALUE] The RLP hex-encoded data

Options:
-h, --help
Print help (see a summary with '-h')
-h, --help Print help
```
11 changes: 8 additions & 3 deletions src/reference/cli/cast/to-rlp.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# cast to-rlp

RLP encodes hex data, or an array of hex data
RLP encodes hex data, or an array of hex data.

```bash
$ cast to-rlp --help
Usage: cast to-rlp [VALUE]

Arguments:
[VALUE] The value to convert
[VALUE]
The value to convert.

This is a hex-encoded string, or an array of hex-encoded strings. Can be arbitrarily
recursive.

Options:
-h, --help Print help
-h, --help
Print help (see a summary with '-h')
```
21 changes: 17 additions & 4 deletions src/reference/cli/forge/soldeer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,30 @@ Soldeer dependency manager
```bash
$ forge soldeer --help
Usage: forge soldeer install [DEPENDENCY]~[VERSION] <REMOTE_URL>
forge soldeer install [DEPENDENCY]~[VERSION] <GIT_URL>
forge soldeer install [DEPENDENCY]~[VERSION] <GIT_URL> --rev <REVISION>
forge soldeer install [DEPENDENCY]~[VERSION] <GIT_URL> --rev <TAG>
forge soldeer push [DEPENDENCY]~[VERSION] <CUSTOM_PATH_OF_FILES>
forge soldeer login
forge soldeer update
forge soldeer version

Commands:
install Install a dependency from soldeer repository or from a custom url that points
to a zip file.
Example: soldeer install @openzeppelin-contracts~2.3.0 the `~` is very
important to differentiate between the name and the version that needs to be
installed.
to a zip file or from git using a git link.
IMPORTANT!! The `~` when specifying the dependency is very important to
differentiate between the name and the version that needs to be
installed.
Example from remote repository: soldeer install
@openzeppelin-contracts~2.3.0
Example custom url: soldeer install @openzeppelin-contracts~2.3.0
https://github.com/OpenZeppelin/openzeppelin-contracts/archive/refs/tags/v5.0.2.zip
Example git: soldeer install @openzeppelin-contracts~2.3.0
[email protected]:OpenZeppelin/openzeppelin-contracts.git
Example git with specified commit: soldeer install
@openzeppelin-contracts~2.3.0
[email protected]:OpenZeppelin/openzeppelin-contracts.git --rev
05f218fb6617932e56bf5388c3b389c3028a7b73
update Update dependencies by reading the config file.
login Login into the central repository to push the dependencies.
push Push a dependency to the repository. The PATH_TO_DEPENDENCY is optional and
Expand Down
5 changes: 3 additions & 2 deletions src/reference/cli/forge/soldeer/install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# forge soldeer install

Install a dependency from soldeer repository or from a custom url that points to a zip file.
Install a dependency from soldeer repository or from a custom url that points to a zip file or from

```bash
$ forge soldeer install --help
Expand All @@ -11,7 +11,8 @@ Arguments:
[REMOTE_URL]

Options:
-h, --help Print help
--rev <REV>
-h, --help Print help

For more information, read the README.md
```

0 comments on commit caeec39

Please sign in to comment.