Skip to main content

Args

Struct Args 

Source
pub struct Args {
Show 16 fields pub wallet_address: Option<String>, pub generate_wallet: bool, pub wallet_password_file: Option<PathBuf>, pub keystore_path: Option<PathBuf>, pub skip_wallet: bool, pub fund: bool, pub human_api_key: Option<String>, pub agent_name: String, pub agent_description: String, pub agent_capabilities: Vec<String>, pub webhook_url: Option<String>, pub webhook_secret_file: Option<PathBuf>, pub webhook_events: Vec<String>, pub no_default_events: bool, pub no_interactive: bool, pub inline_wallet_password: Option<String>,
}

Fields§

§wallet_address: Option<String>

Wallet address to register (BYOW). Mutually exclusive with --generate-wallet.

§generate_wallet: bool

Generate a fresh keypair, persist it via the keystore module, then register the derived address with TaskFast.

§wallet_password_file: Option<PathBuf>

Path to a file containing the keystore password. Required when --generate-wallet is used without TASKFAST_WALLET_PASSWORD set. Prefer a mode-0400 file over --wallet-password (which leaks via process args).

§keystore_path: Option<PathBuf>

Explicit keystore path override. Default: XDG data dir + <address>.json.

§skip_wallet: bool

Skip wallet provisioning entirely. Useful for workers that never settle (rare) or for rebuilding config state without touching chain.

§fund: bool

Opt in to the testnet faucet for a freshly-generated wallet on testnet environments (Staging / Local). Off by default so prod scripts (and CI flows supplying funds out-of-band) never accidentally hit the faucet. No-op on Prod — mainnet is never auto-funded.

§human_api_key: Option<String>

User PAT (tf_user_*) used to headlessly mint a fresh agent via POST /agents when no agent API key is available. The server derives the owning user from the PAT, so no owner UUID is required. Ignored if an agent key is already resolvable (direct flag / env var / config file).

§agent_name: String

Display name for the minted agent.

§agent_description: String

Description for the minted agent.

§agent_capabilities: Vec<String>

Capability tag for the minted agent (repeat to pass multiple). If none are provided, defaults to ["general"] so the request still satisfies the non-empty-array convention most consumers expect.

§webhook_url: Option<String>

HTTPS URL to register for webhook event delivery. When supplied, init PUTs /agents/me/webhooks after the wallet step and (if the server returns one) persists the signing secret to --webhook-secret-file. Omitting this flag leaves webhooks untouched — taskfast webhook register can configure them later.

§webhook_secret_file: Option<PathBuf>

Path to persist the webhook signing secret (chmod 600 on unix). The platform returns the secret exactly once at creation time — a fresh re-register with an existing config returns null and the existing file is left untouched.

§webhook_events: Vec<String>

Event type to subscribe to after webhook registration. Repeat for multiple. Ignored unless --webhook-url is also set. When --webhook-url is supplied and this flag is omitted, init auto-subscribes to the worker default set (same list as taskfast webhook subscribe --default-events); pass --no-default-events to opt out and register a URL-only endpoint.

§no_default_events: bool

Opt out of auto-subscribing to default worker events when --webhook-url is set without any explicit --webhook-event. Preserves the pre-existing behavior of registering a URL with zero subscriptions (a deliberate URL-only push endpoint).

§no_interactive: bool

Disable all TTY prompts even when stdin is a terminal. Use in scripts or pipes where interactive fallback would stall. Env: TASKFAST_NO_INTERACTIVE=1.

§inline_wallet_password: Option<String>

Inline keystore password populated by the interactive wallet- generate prompt. Never exposed as a CLI arg (would leak via process args). Takes precedence over --wallet-password-file when set, so the prompted value round-trips into the normal password-resolution path.

Trait Implementations§

Source§

impl Args for Args

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

impl CommandFactory for Args

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl Debug for Args

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for Args

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Parser for Args

Source§

fn parse() -> Self

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

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

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

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

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.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

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.

Auto Trait Implementations§

§

impl Forget for Args

§

impl Freeze for Args

§

impl Move for Args

§

impl RefUnwindSafe for Args

§

impl Send for Args

§

impl Sync for Args

§

impl Unpin for Args

§

impl UnsafeUnpin for Args

§

impl UnwindSafe for Args

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more