Struct forest_filecoin::cli_shared::cli::CliOpts

pub struct CliOpts {

    pub config: Option<PathBuf>,
    pub genesis: Option<PathBuf>,
    pub rpc: Option<bool>,
    pub no_metrics: bool,
    pub metrics_address: Option<SocketAddr>,
    pub rpc_address: Option<SocketAddr>,
    pub no_healthcheck: bool,
    pub healthcheck_address: Option<SocketAddr>,
    pub p2p_listen_address: Option<Vec<Multiaddr>>,
    pub kademlia: Option<bool>,
    pub mdns: Option<bool>,
    pub height: Option<i64>,
    pub head: Option<u64>,
    pub import_snapshot: Option<String>,
    pub import_mode: ImportMode,
    pub halt_after_import: bool,
    pub skip_load: Option<bool>,
    pub req_window: Option<usize>,
    pub tipset_sample_size: Option<u8>,
    pub target_peer_count: Option<u32>,
    pub encrypt_keystore: Option<bool>,
    pub chain: Option<NetworkChain>,
    pub detach: bool,
    pub auto_download_snapshot: bool,
    pub color: LoggingColor,
    pub tokio_console: bool,
    pub loki: bool,
    pub loki_endpoint: String,
    pub log_dir: Option<PathBuf>,
    pub exit_after_init: bool,
    pub save_token: Option<PathBuf>,
    pub track_peak_rss: bool,
    pub no_gc: bool,
    pub stateless: bool,
    pub dry_run: bool,
    pub skip_load_actors: bool,
}

CLI options

Fields

config: Option<PathBuf>

A TOML file containing relevant configurations

genesis: Option<PathBuf>

The genesis CAR file

rpc: Option<bool>

Allow RPC to be active or not (default: true)

no_metrics: bool

Disable Metrics endpoint

metrics_address: Option<SocketAddr>

Address used for metrics collection server. By defaults binds on localhost on port 6116.

rpc_address: Option<SocketAddr>

Address used for RPC. By defaults binds on localhost on port 2345.

no_healthcheck: bool

Disable healthcheck endpoints

healthcheck_address: Option<SocketAddr>

Address used for healthcheck server. By defaults binds on localhost on port 2346.

p2p_listen_address: Option<Vec<Multiaddr>>

P2P listen addresses, e.g., --p2p-listen-address /ip4/0.0.0.0/tcp/12345 --p2p-listen-address /ip4/0.0.0.0/tcp/12346

kademlia: Option<bool>

Allow Kademlia (default: true)

mdns: Option<bool>

Allow MDNS (default: false)

height: Option<i64>

Validate snapshot at given EPOCH, use a negative value -N to validate the last N EPOCH(s) starting at HEAD.

head: Option<u64>

Sets the current HEAD epoch to validate to. Useful to specify a smaller range in conjunction with height, ignored if height is unspecified.

import_snapshot: Option<String>

Import a snapshot from a local CAR file or URL

import_mode: ImportMode

Snapshot import mode. Available modes are copy, move and symlink.

halt_after_import: bool

Halt with exit code 0 after successfully importing a snapshot

skip_load: Option<bool>

Skips loading CAR file and uses header to index chain. Assumes a pre-loaded database

req_window: Option<usize>

Number of tipsets requested over one chain exchange (default is 8)

tipset_sample_size: Option<u8>

Number of tipsets to include in the sample that determines what the network head is (default is 5)

target_peer_count: Option<u32>

Amount of Peers we want to be connected to (default is 75)

encrypt_keystore: Option<bool>

Encrypt the key-store (default: true)

chain: Option<NetworkChain>

Choose network chain to sync to

detach: bool

Daemonize Forest process

auto_download_snapshot: bool

Automatically download a chain specific snapshot to sync with the Filecoin network if needed.

color: LoggingColor

Enable or disable colored logging in stdout

tokio_console: bool

Turn on tokio-console support for debugging. Memory leak, see https://github.com/tokio-rs/console/pull/501.

loki: bool

Send telemetry to grafana loki

loki_endpoint: String

Endpoint of grafana loki

log_dir: Option<PathBuf>

Specify a directory into which rolling log files should be appended

exit_after_init: bool

Exit after basic daemon initialization

save_token: Option<PathBuf>

If provided, indicates the file to which to save the admin token.

track_peak_rss: bool

Track peak physical memory usage and print on exit

no_gc: bool

Disable the automatic database garbage collection.

stateless: bool

In stateless mode, forest connects to the P2P network but does not sync to HEAD.

dry_run: bool

Check your command-line options and configuration file if one is used

skip_load_actors: bool

Skip loading actors from the actors bundle.

Implementations

impl CliOpts

pub fn to_config(&self) -> Result<(Config, Option<ConfigPath>), Error>

Trait Implementations

impl Args for CliOpts

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for CliOpts

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CliOpts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CliOpts

fn default() -> CliOpts

Returns the “default value” for a type.

impl FromArgMatches for CliOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CliOpts

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.