Command-line interface reference¶

This page provides documentation of Silkaj command line interface.

silkaj¶

Usage:

silkaj [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`-h`, `--help`	boolean	Show this message and exit.	`False`
`-v`, `--version`	boolean	Show the version and exit.	`False`
`--endpoint`, `-ep`	text	Without specifying this option, the default endpoint reaches Ğ1 currency on its official endpoint: https://g1.duniter.org. --endpoint allows to specify a custom endpoint following `<host>:<port>/<path>` format. `port` and `path` are optional. In case no port is specified, it defaults to 443. NOTE: This argument is mutually exclusive with arguments: [gtest].	None
`--gtest`, `-gt`	boolean	Uses official ĞTest currency endpoint: https://g1-test.duniter.org NOTE: This argument is mutually exclusive with arguments: [endpoint].	`False`
`--account`, `-a`	text	Account name used in storage `$HOME/.local/share/silkaj/$currency/$account_name` for authentication and revocation.	None
`--password`, `-p`	text	EWIF authentication password. If you use this option, prefix the command with a space so the password is not saved in your shell history. In case of an encrypted file, password input will be prompted.	None
`--display`, `-d`	boolean	Display the generated document before sending it	`False`
`--dry-run`, `-n`	boolean	By-pass the licence and confirmation. Do not send the document, but display it instead	`False`

Subcommands

about: Display program information
authentication: Generate and store authentication file
blockchain: Blockchain related commands
checksum: Generate checksum out of a passed pubkey or an authentication method. Checks if the passed checksum is valid.
license: Display Ğ1 monetary license
money: Money management related commands
wot: Web-of-Trust related commands

silkaj about¶

Display program information

Usage:

silkaj about [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj authentication¶

Generate and store authentication file

Usage:

silkaj authentication [OPTIONS]

Options:

Name	Type	Description	Default
`--auth-scrypt`, `--scrypt`	boolean	Scrypt authentication. Default method NOTE: This argument is mutually exclusive with arguments: [auth_wif, auth_seed, auth_file].	`False`
`--nrp`	text	Scrypt parameters: defaults N,r,p: "4096,16,1"	None
`--auth-file`, `-af`	file	Seed hexadecimal authentication from file path NOTE: This argument is mutually exclusive with arguments: [auth_wif, auth_seed, auth_scrypt].	None
`--auth-seed`, `--seed`	boolean	Seed hexadecimal authentication NOTE: This argument is mutually exclusive with arguments: [auth_wif, auth_file, auth_scrypt].	`False`
`--auth-wif`, `--wif`	boolean	WIF and EWIF authentication methods NOTE: This argument is mutually exclusive with arguments: [auth_seed, auth_file, auth_scrypt].	`False`
`--password`, `-p`	text	EWIF encryption password for the destination file. If no password argument is passed, WIF format will be used. If you use this option prefix the command with a space so the password does not get saved in your shell history. Password input will be suggested via a prompt.	None
`--help`	boolean	Show this message and exit.	`False`

silkaj blockchain¶

Blockchain related commands

Usage:

silkaj blockchain [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

blocks: Display blocks: default: 0 for current window size
difficulty: Display current Proof-of-Work difficulty level to generate next block
info: Currency information

silkaj blockchain blocks¶

Display blocks: default: 0 for current window size

Usage:

silkaj blockchain blocks [OPTIONS] [NUMBER]

Options:

Name	Type	Description	Default
`--detailed`, `-d`	boolean	Force detailed view. Compact view happen over 30 blocks	`False`
`--help`	boolean	Show this message and exit.	`False`

silkaj blockchain difficulty¶

Display current Proof-of-Work difficulty level to generate next block

Usage:

silkaj blockchain difficulty [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj blockchain info¶

Currency information

Usage:

silkaj blockchain info [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj checksum¶

Generate checksum out of a passed pubkey or an authentication method. Checks if the passed checksum is valid.

Usage:

silkaj checksum [OPTIONS] [PUBKEY_CHECKSUM]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj license¶

Display Ğ1 monetary license

Usage:

silkaj license [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj money¶

Money management related commands

Usage:

silkaj money [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

balance: Wallet·s balance·s. Multiple public keys can be passed, then a sum is computed. Also works with the authentication.
history: History of wallet money movements
transfer: Transfer money

silkaj money balance¶

Wallet·s balance·s. Multiple public keys can be passed, then a sum is computed. Also works with the authentication.

Usage:

silkaj money balance [OPTIONS] [PUBKEYS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj money history¶

History of wallet money movements

Usage:

silkaj money history [OPTIONS] PUBKEY

Options:

Name	Type	Description	Default
`--uids`, `-u`	boolean	Display identities username	`False`
`--full-pubkey`, `-f`	boolean	Display full-length public keys	`False`
`--csv-file`, `--csv`	file	Write in specified file name in CSV (Comma-separated values) format the history of money movements	None
`--help`	boolean	Show this message and exit.	`False`

silkaj money transfer¶

Transfer money

Usage:

silkaj money transfer [OPTIONS]

Options:

Name	Type	Description	Default
`--amount`, `-a`	float range (`0.01` and above)	Quantitative amount(s). NOTE: This argument is mutually exclusive with arguments: [file_path, allsources, amountsud].	None
`--amountUD`, `-d`	float range (`1e-06` and above)	Relative amount(s). NOTE: This argument is mutually exclusive with arguments: [file_path, allsources, amounts].	None
`--allSources`	boolean	Send all sources to one recipient. NOTE: This argument is mutually exclusive with arguments: [file_path, amountsud, amounts].	`False`
`--recipient`, `-r`	text	Public key(s)' recipients + optional checksum: `<pubkey>[:checksum]`. Sending to multiple recipients is possible. With one amount specified, all recipients will receive the same amount. With one amount specified per recipient, recipient 1 will recieve amount 1, and so on. NOTE: This argument is mutually exclusive with arguments: [file_path].	None
`--file`, `-f`	file	File's path containing a list of amounts in absolute or relative reference and recipients' pubkeys NOTE: This argument is mutually exclusive with arguments: [amountsUD, recipients, allsources, amounts].	None
`--reference`, `-ref`	text	Transfer reference	``
`--outputBackChange`	text	Pubkey recipient to send the rest of the transaction: `<pubkey[:checksum]>`	None
`--yes`, `-y`	boolean	Assume yes. Do not prompt confirmation	`False`
`--help`	boolean	Show this message and exit.	`False`

silkaj wot¶

Web-of-Trust related commands

Usage:

silkaj wot [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

certify: Certify identity
lookup: Username identifier and public key lookup
membership: Send or renew membership.
revocation: Manage revocation document commands.
status: Check received and sent certifications and consult the membership status of any given identity

silkaj wot certify¶

Certify identity

Usage:

silkaj wot certify [OPTIONS] UID_PUBKEY_TO_CERTIFY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot lookup¶

Username identifier and public key lookup

Usage:

silkaj wot lookup [OPTIONS] UID_PUBKEY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot membership¶

Send or renew membership.

Usage:

silkaj wot membership [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot revocation¶

Manage revocation document commands.

Usage:

silkaj wot revocation [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create and save revocation document
publish: Publish previously created revocation document. Identity will be immediately revoked.
revoke: Create and publish revocation document. Will immediately revoke the identity.
verify: Verifies that the revocation document is correctly formatted and matches an existing identity

silkaj wot revocation create¶

Create and save revocation document

Usage:

silkaj wot revocation create [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot revocation publish¶

Publish previously created revocation document. Identity will be immediately revoked.

Usage:

silkaj wot revocation publish [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot revocation revoke¶

Create and publish revocation document. Will immediately revoke the identity.

Usage:

silkaj wot revocation revoke [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot revocation verify¶

Verifies that the revocation document is correctly formatted and matches an existing identity

Usage:

silkaj wot revocation verify [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

silkaj wot status¶

Check received and sent certifications and consult the membership status of any given identity

Usage:

silkaj wot status [OPTIONS] UID_PUBKEY

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`