Skip to content

Commit

Permalink
chore(cli): update outdated documentation (#3581)
Browse files Browse the repository at this point in the history
  • Loading branch information
1garo authored Nov 14, 2023
1 parent ea49251 commit faf1849
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
8 changes: 4 additions & 4 deletions cmd/gossamer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ gossamer version
### Initialize the node

```bash
gossamer init --chain westend --key alice --basepath /tmp/gossamer
gossamer init --chain westend --key alice --base-path /tmp/gossamer
```

This initialises the node with the default configuration for the `westend` chain with the `alice` keypair at the base-path `/tmp/gossamer`.
Expand All @@ -45,7 +45,7 @@ This initialises the node with the default configuration for the `westend` chain
Supported flags:
--chain: The chain spec to initialise the node with. Supported chains are `polkadot`, `kusama`, `westend`, `westend-dev` and `westend_local`. It also accepts the chain-spec json path.
--key: The keypair to use for the node.
--basepath: The working directory for the node.
--base-path: The working directory for the node.
```

The init command will create the following files in the base-path:
Expand All @@ -63,15 +63,15 @@ The node configuration can be modified in the `config.toml` file.
### Start the node

```bash
gossamer --basepath /tmp/gossamer --key alice
gossamer --base-path /tmp/gossamer --key alice
```

**Note: The `init` command is optional. If the node is not initialised, it will be initialised with the default configuration.**

Here are the list of basic flags for the `gossamer` command:

```
--basepath: The working directory for the node.
--base-path: The working directory for the node.
--chain: The chain spec to initialise the node with. Supported chains are `polkadot`, `kusama`, `westend`, `westend-dev` and `westend_local`. It also accepts the chain-spec json path.
--key: The keypair to use for the node.
--name: The name of the node.
Expand Down
12 changes: 5 additions & 7 deletions cmd/gossamer/commands/account.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,13 @@ var AccountCmd = &cobra.Command{
Use: "account",
Short: "Create and manage node keystore accounts",
Long: `The account command is used to manage the gossamer keystore.
Examples:
Examples:
To generate a new sr25519 account:
gossamer account generate --keystore-path=path/to/location --scheme=sr25519
To generate a new ed25519 account:
gossamer account generate --ed25519
To generate a new secp256k1 account:
To generate a new ed25519 account:
gossamer account generate --keystore-path=path/to/location --scheme=ed25519
To generate a new secp256k1 account:
gossamer account generate --keystore-path=path/to/location --scheme secp256k1
To import a keystore file:
To import a keystore file:
gossamer account import --keystore-path=path/to/location --keystore-file=keystore.json
To import a raw key:
gossamer account import-raw --keystore-path=path/to/location --keystore-file=keystore.json
Expand Down

0 comments on commit faf1849

Please sign in to comment.