Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
N
nebula
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
exchain
nebula
Commits
ef015c16
Unverified
Commit
ef015c16
authored
Mar 02, 2023
by
Ori Pomerantz
Committed by
GitHub
Mar 02, 2023
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
feat(atst/cli): Edit cli.md
parent
c591b584
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
33 additions
and
40 deletions
+33
-40
cli.md
packages/atst/docs/cli.md
+33
-40
No files found.
packages/atst/docs/cli.md
View file @
ef015c16
# atst cli docs

## Installation
```
bash
...
...
@@ -12,10 +14,10 @@ npm install @eth-optimism/atst --global
npx atst <
command
>
[
options]
```
## Commands
##
#
Commands
read
read an attestation
write
write an attestation
-
`read`
read an attestation
-
`write`
write an attestation
For more info, run any command with the
`--help`
flag:
...
...
@@ -24,55 +26,46 @@ npx atst read --help
npx atst write
--help
```
## Options:
-h, --help Display this message
-v, --version Display version number
## Usage:
```
bash
npx atst <
command
>
[
options]
```
Commands:
read read an attestation
write write an attestation
### General options
For more info, run any command with the
`--help`
flag:
-
`-h`
,
`--help`
Display help message
-
`-v`
,
`--version`
Display version number
```
bash
npx atst
read
--help
npx atst write
--help
```
### Read
`--creator <string> Address of the creator of the attestation`
`--about <string> Address of the subject of the attestation`
`--key <string> Key of the attestation either as string or hex number`
`--data-type [string] Zod validator for the DataType type string | bytes | number | bool | address (default: string)`
`--rpc-url [url] Rpc url to use (default: https://mainnet.optimism.io)`
`--contract [address] Contract address to read from (default: 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77)`
`-h, --help Display this message`
-
`--creator <address>`
Address of the creator of the attestation
-
`--about <address>`
Address of the subject of the attestation
-
`--key <string>`
Key of the attestation either as string or hex number
-
`[--data-type <string>]`
[
Zod validator
](
https://zod.dev/
)
for the DataType type
`string`
|
`bytes`
|
`number`
|
`bool`
|
`address`
(default:
`string`
)
-
`[--rpc-url <url>]`
Rpc url to use (default:
`https://mainnet.optimism.io`
)
-
`[--contract <address>]`
Contract address to read from (default:
`0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77`
)
-
`-h`
,
`--help`
Display help message
Example:
```
bash
npx atst
read
--key
"optimist.base-uri"
--about
0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5
--creator
0x60c5C9c98bcBd0b0F2fD89B24c16e533BaA8CdA3
npx atst
read
--key
"optimist.base-uri"
--about
0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5
\
--creator
0x60c5C9c98bcBd0b0F2fD89B24c16e533BaA8CdA3
```
### write
### Write
-
`--private-key <string>`
Private key of the creator of the attestation
-
`[--data-type <string>]`
[
Zod validator
](
https://zod.dev/
)
for the DataType type
`string`
|
`bytes`
|
`number`
|
`bool`
|
`address`
(default:
`string`
)
-
`--about <address>`
Address of the subject of the attestation
-
`--key <address>`
Key of the attestation either as string or hex number
-
`--value <string>`
undefined
-
`[--rpc-url <url>]`
Rpc url to use (default:
`https://mainnet.optimism.io`
)
-
`[--contract <address>]`
Contract address to read from (default: 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77)
-
`-h`
,
`--help`
Display this message
`--private-key <string> Address of the creator of the attestation`
`--data-type [string] Zod validator for the DataType type string | bytes | number | bool | address (default: string)`
`--about <string> Address of the subject of the attestation`
`--key <string> Key of the attestation either as string or hex number`
`--value <string> undefined`
`--rpc-url [url] Rpc url to use (default: https://mainnet.optimism.io)`
`--contract [address] Contract address to read from (default: 0xEE36eaaD94d1Cc1d0eccaDb55C38bFfB6Be06C77) -h, --help Display this message`
Example:
```
bash
atst write
--key
"optimist.base-uri"
--about
0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5
--value
"my attestation"
--private-key
0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
--rpc-url
http://localhost:8545
atst/0.0.0
atst write
--key
"optimist.base-uri"
\
--about
0x2335022c740d17c2837f9C884Bfe4fFdbf0A95D5
\
--value
"my attestation"
\
--private-key
0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
\
--rpc-url
http://localhost:8545
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment