almanak service¶

advanced explicit process operation

usage: almanak service [-h]
                       {gateway,fork-venue,read-gateway,start,resume,status,teardown}
                       ...

almanak service gateway¶

usage: almanak service gateway [-h]
                               (--config CONFIG | --gateway-config GATEWAY_CONFIG)
                               [--read-context READ_CONTEXT | --preparation-file PREPARATION_FILE]
                               [--database DATABASE]
                               (--fork-url FORK_URL | --fork-routes FORK_ROUTES | --production | --fork | --backtest)
                               [--fork-key-file FORK_KEY_FILE]
                               [--env-file ENV_FILE] [--accounts ACCOUNTS]
                               [--key-file KEY_FILE]
                               [--password-file PASSWORD_FILE]
                               --auth-token-file AUTH_TOKEN_FILE
                               (--port PORT | --listen-fd LISTEN_FD)
                               [--lease-seconds LEASE_SECONDS]

Option	Details	Description
`--config`	Path
`--gateway-config`	Path	operator provider, account and execution settings
`--read-context`	Path	generated provisional read context
`--preparation-file`	Path	generated frozen deployment preparation
`--database`	Path
`--fork-url`
`--fork-routes`	Path
`--production`
`--fork`		read-only fork origin preparation
`--backtest`		read-only historical preparation
`--fork-key-file`	Path
`--env-file`	Path
`--accounts`	Path	operator-generated account bindings
`--key-file`	Path
`--password-file`	Path
`--auth-token-file`	Path; required
`--port`	int
`--listen-fd`	int	inherited loopback socket, already bound by the supervising process
`--lease-seconds`	float; default `30`

Exactly one of --config, --gateway-config.

At most one of --read-context, --preparation-file.

Exactly one of --fork-url, --fork-routes, --production, --fork, --backtest.

Exactly one of --port, --listen-fd.

almanak service fork-venue¶

a connector's synthesized venue beside an identified fork node

usage: almanak service fork-venue [-h] --spec SPEC --listen-fd LISTEN_FD

Option	Details	Description
`--spec`	Path; required	the workspace's venue spec
`--listen-fd`	int; required	inherited loopback socket, already bound by the workspace

almanak service read-gateway¶

read-only observation gateway holding the provider credentials

usage: almanak service read-gateway [-h] --env-file ENV_FILE --auth-token-file
                                    AUTH_TOKEN_FILE --port PORT

Option	Details	Description
`--env-file`	Path; required	private provider credentials read only by this gateway
`--auth-token-file`	Path; required
`--port`	int; required

almanak service start¶

usage: almanak service start [-h] --gateway-url GATEWAY_URL
                             --gateway-auth-file GATEWAY_AUTH_FILE --config
                             CONFIG [--export EXPORT]
                             [--clock-offset-file CLOCK_OFFSET_FILE]
                             [--decision-facts] --strategy STRATEGY

Option	Details	Description
`--gateway-url`	required
`--gateway-auth-file`	Path; required
`--config`	Path; required
`--export`	Path	retain read-only dashboard input snapshots
`--clock-offset-file`	Path	fork test clock: whole seconds added to wall time for decision timing
`--decision-facts`		fork test run: log what each decision saw for the test verdict
`--strategy`	Path; required

almanak service resume¶

usage: almanak service resume [-h] --gateway-url GATEWAY_URL
                              --gateway-auth-file GATEWAY_AUTH_FILE
                              [--config CONFIG] [--export EXPORT]
                              [--clock-offset-file CLOCK_OFFSET_FILE]
                              [--decision-facts]

Option	Details	Description
`--gateway-url`	required
`--gateway-auth-file`	Path; required
`--config`	Path
`--export`	Path	retain read-only dashboard input snapshots
`--clock-offset-file`	Path	fork test clock: whole seconds added to wall time for decision timing
`--decision-facts`		fork test run: log what each decision saw for the test verdict

almanak service status¶

usage: almanak service status [-h] [--gateway-url GATEWAY_URL]
                              [--gateway-auth-file GATEWAY_AUTH_FILE]
                              [--database DATABASE]

Option	Details	Description
`--gateway-url`
`--gateway-auth-file`	Path
`--database`	Path

almanak service teardown¶

usage: almanak service teardown [-h] --gateway-url GATEWAY_URL
                                --gateway-auth-file GATEWAY_AUTH_FILE

Option	Details	Description
`--gateway-url`	required
`--gateway-auth-file`	Path; required