Skip to content

Commit

Permalink
Update README.md (#564)
Browse files Browse the repository at this point in the history
* Update README.md

update examples to match current subcommand run call structure

* Update README.md

Co-authored-by: Brandon Kite <brandonkite92@gmail.com>

Co-authored-by: Brandon Kite <brandonkite92@gmail.com>
mitch-fuel and Voxelot authored Aug 15, 2022
1 parent a0351c2 commit 0a36d47
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -49,29 +49,28 @@ This will run `cargo build` as well as any other custom build processes we have

## Running

The service can listen to an arbitrary socket, as specified in the help command:
The service can be launched by executing `fuel-core run`. The list of options for running can be accessed via the `help` option:

```console
$ ./target/debug/fuel-core --help
fuel-core 0.1.0
$ ./target/debug/fuel-core run --help

USAGE:
fuel-core [OPTIONS]

FLAGS:
-h, --help Prints help information
-V, --version Prints version information
fuel-core run [OPTIONS]

OPTIONS:
--ip <ip> [default: 127.0.0.1]
--port <port> [default: 4000]
--db-path <file path> [default: None]
--chain <CHAIN_CONFIG>
Specify either an alias to a built-in configuration or filepath to a JSON file [default:
local_testnet]
...
```


For many development puposes it is useful to have a state that won't persist and the `db-type` option can be set to `in-memory` as in the following example.

#### Example

```console
$ ./target/debug/fuel-core --ip 127.0.0.1 --port 4000
$ ./target/debug/fuel-core run --db-type in-memory
Jul 12 23:28:47.238 INFO fuel_core: Binding GraphQL provider to 127.0.0.1:4000
```

0 comments on commit 0a36d47

Please sign in to comment.