This document lists the command line functions available to NESTS users with different privilege levels.
NB, this document was created well before work started on coding the CLI functions. It is currently undergoing a major revision while the CLI functions and their tests are being written.
Therefore expect to find inconsistencies and omissions, especially in the numbering of the footnotes.
The first stable version is expected to be available soon.
This is currently a very limited set of functions, sufficient to meet the needs of an open money implementation but not yet for open measures.
There are two classes of user functions:
Lower-level functions providing a CLI to the NESTS core library.
These are scripts written in the same language as the NESTS core and all have *nix permission 0550.
Shell script wrappers to enable remote calls to the NESTS CLI over SSH.
These are created indvidually for each user to whom an SSH login account has been assigned 4.2.c, containing a unique authentication code generated automatically, and have *nix permission 0500.
Any user becomes a steward 5 once having been authorized to create an entity (whether a secondary identity), an account, a currency or a child namespace. That authorization comes from the steward(s) 5 of the namespace enclosing the new entity and they/it can suspend or revoke such authorization.
Notes:
The initial implementation is written in Python, but its modular design makes it fairly easy to re-write components in Rust, Perl or Ruby. In due course, some additional components may be written in R.
Most users are unlikely to have any use for command line execution over SSH, but for some it will provide a convenient, powerful and scriptable interface.
It may be sufficient to set the permissions on such scripts to 0500, but
at the very least a restricted login shell should be assigned in
/etc/passwd and a better solution might be to write an
ad hoc script for use as the login shell, allowing only the
execution of the commands in this group and possibly combining them into
a single script for the purpose. This will require some experimentation.
The steward(s) of each namespace can choose whether the default policy is
The policy 9 can be configured differently for each entity. For example, it might present too great an oversight burden to require explicit authorization from the steward(s) of that namespace each time a secondary identity, an account or a currency is created there.
On the other hand, the creation of child namespaces requires more sensitivity to the needs of others, especially where assigned to a geographical equivalence (which may be a genuine needs case for some form of regional governance collective).
Furthermore, authorization of the creation of a new account must also come from a steward 5 of the associated currency. Therefore a sensible default policy 9 might be
| Table 1: commands available to users | ||||||||
|
This table lists the shell commands any registered NESTS user (i.e. having a primary identity) can use. These include commands for the creation of a secondary identity, account, currency or namespace - each involving an implicit request to the stewards of that entity's parent namespace or, for an account, the stewards of the associated currency. Upon authorization, the user issuing such a request becomes the steward of that new entity. Therefore the only distinction between a steward and any other user (identity-holder) lies in the holding of stewardship within a particular domain. Within the domain of entities 1 over which they hold stewardship, users have additonial commands available. Furthermore, the domain of currency stewards differs from that of namespace stewards. An account lies almost exclusively within the domain of the identity to which it belongs. However, the stewards of the namespace in which it is contained and of the associated currency have a limited and conditional domain here as well when necessary, to suspend activity or to examine ledgers, but never to modify the value of an account in anyway that. Modification of an account is exclusively the right of its owner or, where granted, another identity to which write/update access has been granted (a situation unlikely to arise with any frequency but which may occasionally be useful). |
available to | |||||||
primary identity
|
secondary identity
|
namespace steward
|
currency steward
|
system administrator
|
||||
| command | option | parameter | description | |||||
| accounts | ||||||||
| nests_list_own_accounts | --show-balances | List the accounts (by FPH or HRNS) belonging to the identity requesting. | y | y | ||||
| --list-fph | ||||||||
| --human-readable | ||||||||
| -u | --identity-fph | <requester identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_list_accounts_in_currency | -c | --currency-fph | <currency FPH> |
List the accounts (by FPH or HRNS) associated with the currency specified. The requesting identity must be a steward of that currency. Otherwise an error message is returned. |
y | ||||
| --show-balances | ||||||||
| --list-fph | ||||||||
| --human-readable | ||||||||
| -u | --identity-fph | <steward identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_list_accounts_in_namespace | -n | --namespace-fph | <namespace FPH> |
List the accounts (by FPH or HRNS) contained within the namespace specified. The requesting identity must be a steward of that namespace. Otherwise an error message is returned. |
y | ||||
| --show-balances | ||||||||
| --list-fph | ||||||||
| --human-readable | ||||||||
| -u | --identity-fph | <steward identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_pay | -f | --payer-fph | <payer account FPH> 2.c |
Make a payment 7 from one account to another in the same currency. 6 Returns (to STDOUT, as a JSON structure) the record appended to the transaction journals of the payer, the payee and the currency's stewards. |
y | y | n | n | n |
| -t | --payee-fph | <payee account FPH> 2.c | |||||||
| -A | --amount | <amount> 6 | |||||||
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_set_value 10 | -a | --account-fph | <account FPH> 2.c |
Set the value of an account (scalar, vector or matrix). The account FPH may be passed either to STDIN or via the -a | --account-fph parameter. |
y | y | n | n | n |
| -A | --amount | <amount> 6.a, 7 | |||||||
| -S | --scalar | <scalar value> 6.a | |||||||
| -V | --vector | <vector value> 6.b | |||||||
| -M | --matrix | <matrix value> 6.c | |||||||
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_add_value 10 | -a | --account-fph | <account FPH> 2.c | Add the value specified to an account (scalar, vector or matrix). | y | y | n | n | n |
| -A | --amount | <amount> 6.a, 7 | |||||||
| -S | --scalar | <scalar value> 6.a | |||||||
| -V | --vector | <vector value> 6.b | |||||||
| -M | --matrix | <matrix value> 6.c | |||||||
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_subtract_value 10 | -a | --account-fph | <account FPH> 2.c |
Subtract the value specified from an account (scalar, vector or matrix). The account FPH may be passed either to STDIN or via the -a | --account-fph parameter. |
y | y | n | n | n |
| -A | --amount | <amount> 6.a, 7 | |||||||
| -S | --scalar | <scalar value> 6.a | |||||||
| -V | --vector | <vector value> 6.b | |||||||
| -M | --matrix | <matrix value> 6.c | |||||||
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_multiply_by_value 10 | -a | --account-fph | <account FPH> 2.c |
Multiply the account value (scalar, vector or matrix) by value the specified (scalar, vector or matrix). The account FPH may be passed either to STDIN or via the -a | --account-fph parameter. |
y | y | n | n | n |
| -S | --scalar | <scalar value> 6.a | |||||||
| -V | --vector | <vector value> 6.b | |||||||
| -M | --matrix | <matrix value> 6.c | |||||||
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_current_value 11 | -a | --account-fph | <account FPH> 2.c |
Export 9 a JSON object showing the current state 10 of an account identified by FPH 2.c. The account FPH may be passed either to STDIN or via the -a | --account-fph parameter. |
y | y | y | y | y |
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_list_transactions | -a | --account-fph | <account FPH> 2.c |
List all transactions (CSV dump) on this account identified by FPH 2.c. This action can be initated only by the account holder. The transactions are exported as CSV. |
y | y | n | n | n |
| -D | --starting | <start date> 8 | |||||||
| -E | --ending | <end date> 8 | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_create | -Z | --account-name | <account name> |
An account is created in the specified namespace 1.a and associated with the specified currency 6. The FPH of the account is returned as STDOUT. |
y | y | n | n | y |
| -n | --namespace-fph | <namespace FPH> 2.c | |||||||
| -c | --currency-fph | <currency FPH> 2.c | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_suspend 12 | -a | --account-fph | <account FPH> 6 |
Disable/suspend a account. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_enable 12 | -a | --account-fph | <account FPH> 2.c |
Re-enable a account. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_delete 12 | -a | --account-fph | <account FPH> 2.c |
Delete account. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_authorize_access | -a | --account-fph | <account FPH> 6 | Authorize account access to the identity (primary or secondary). | n | n | y | n | n |
| --identity | <share identity FPH> | |||||||
| --read-only | ||||||||
| --read-write | ||||||||
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_list_access | -a | --account-fph | <account FPH> 6 | List identities to which account access has been authorized. | n | n | y | n | n |
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_account_authorize_creation | -a | --account-fph | <account FPH> 6 | Authorize creation of account identified by FPH (STDIN). | n | n | y | n | n |
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| currencies | ||||||||
| nests_currency_list_transactions 12, 13 | -c | --currency-fph | <currency FPH> 2.c |
Export a CSV dump of all transactions on all accounts in a currency identified by FPH. This action can be initated only by a steward of the currency or by a steward 5 of the containing namespace or one of its ancestors. |
n | n | n | y | y |
| -D | --starting | <start date> 9 | |||||||
| -E | --ending | <end date> 9 | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_list_currency_stewards | -c | --currency | <currecncy FPH> |
List all identities having stewardship of the specified currency. The listing may be restricted to a specified parent namespace if specified. |
n | n | n | y | y |
| -n | --namespace | <parent namespace FPH> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_list_own_currencies | -n | --namespace | <parent namespace FPH> |
Export a CSV dump of all currencies over which the querying identity holds stewardship. The listing may be restricted to a specified parent namespace if specified. |
n | n | n | y | y |
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currencies_list_available 14 | -u | --identity-fph | <user identity FPH> 2.c |
List (potentially) available currencies to STDOUT. These currencies may be listed either by their full human-readable name.namespace string (--hrn - the default behaviour) or by their FPH (--fph). |
y | y | y | n | y |
| --hrn | ||||||||
| --fph | ||||||||
| --csv | ||||||||
| --json | ||||||||
| --permissiveness | ||||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currencies_list_prototypes 12 | -u | --identity-fph | <user identity FPH> 2.c | List valid currency prototypes to STDOUT. | y | y | y | n | y |
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currency_create 12 | -C | --currency-name | <currency name> |
A currency of the type specified 6 is created and the initial stewardship 5 is assigned to the steward specified. The currency's name is specified as a human-readable string while its namespace is specified by FPH. The FPH 2.c of the new currency is returned as STDOUT. |
y | y | y | n | y |
| -n | --namespace-fph | <namespace FPH> 2.c | |||||||
| -s | --steward | <steward FPH> 2.c, 17 [1 or more] | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currency_suspend 12 | -c | --currency-fph | <currency FPH> 6 |
Disable/suspend a currency. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currency_enable 12 | -c | --currency-fph | <currency FPH> 2.c |
Re-enable a currency. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currency_delete 12 | -c | --currency-fph | <currency FPH> 2.c |
Delete currency. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currency_authorize_creation 12 | -c | --currency-fph | <currency FPH> | Authorize creation of currency identified by FPH (STDIN). | n | n | y | n | n |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_currency_set_policy 12 | -c | --currency-fph | <currency FPH> 2.c |
Define the policy for the creation of accounts in this currency. 6 |
n | n | y | y | y |
| -l | --permissive | ||||||||
| -r | --restrictive | ||||||||
| -i | --inherited | inherited 9 | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| identities | ||||||||
| nests_identity_create_primary | -U | --identity-hrn | <username> 2.a |
A primary identity 1.b is created in the specified namespace 1.a. The FPH 2.c of the new primary identity is returned as STDOUT. If the primary identity exists already, the same command can be used to modify its properties. |
n | n | y | n | y |
| -n | --namespace-fph | <namespace FPH> 2.c | |||||||
| -P | --password | <password> 4.2.a | |||||||
| -e | --email | <email> 4.1.b | |||||||
| -T | --phone | <mobile phone number> 4.1.c | |||||||
| -F | --surname | <surname> 4.1.a | |||||||
| -G | --forenames | <forename> 4.1.a | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_identity_create_secondary | -u | --identity-fph | <alias> 2.a |
A secondary identity 2.a is created in the specified namespace 1.a and associated with the specified primary identity.
|
y | n | y | n | y |
| -n | --namespace-fph | <namespace FPH> 2.c | |||||||
| -I | --primary-identity | <primary identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_list_secondary_identities | -u | --identity-fph | <requester identity FPH> |
List all secondary identities linked to the querying identity (whether primary or secondary) querying identity holds stewardship. |
n | n | n | y | y |
| -n | --namespace | <parent namespace FPH> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_identity_authorize_creation | -u | --identity-fph | <identity FPH> 4.2.c | Authorize creation of primary identity or secondary identity identified by FPH 2.c (STDIN). | n | n | y | n | n |
| -q | --notes | <optional notes> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_identity_suspend 12 | -u | --identity-fph | <identity FPH> 6 |
Disable/suspend a identity. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_identity_enable 12 | -u | --identity-fph | <identity FPH> 2.c |
Re-enable a identity. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_identity_delete 12 | -u | --identity-fph | <identity FPH> 2.c |
Delete identity. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| namespaces | ||||||||
| nests_list_own_namespaces | -n | --namespace | <parent namespace FPH> |
Export a CSV dump of all namespaces over which the querying identity holds stewardship. The listing may be restricted to a specified parent namespace if specified. |
n | n | n | y | y |
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_create | -N | --namespace-name | <namespace name> |
A namespace 2.a is created and the initial stewardship 5 is assigned to the stewards specified. 19 The FPH of the new namespace is returned as STDOUT. |
y | y | y | n | y |
| -n | --namespace-fph | <parent namespace FPH> | |||||||
| -s | --steward | <steward FPH> 2.c, 17 [1 or more] | |||||||
| --root-namespace 19 | ||||||||
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_authorize_creation | -n | --namespace-fph | <namspace FPH> | Authorize creation of namespace identified by FPH (STDIN). | n | n | y | n | n |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_suspend | -n | --namespace-fph | <namespace FPH> 2.c |
Disable/suspend a namespace. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_enable | -n | --namespace-fph | <namespace FPH> 2.c |
Re-enable a namespace. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_delete | -n | --namespace-fph | <namespace FPH> 2.c |
Archive and delete a namespace along with all of its descendants. |
n | n | y | y | y |
| -q | --notes | <optional notes> | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_relocate | -n | --namespace-fph | <namespace to move FPH> 2.c |
A namespace (identified by FPH) is relocated (along with all of its descendants) to a new parent namespace identified by HRN. |
n | n | y | y | y |
| -N | --namespace-name | <new parent namespace> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_set_policy | -n | --namespace-fph | <namespace FPH> 2.c |
Define the policy 9 for the creation of namespaces. |
n | n | y | y | y |
| -l | --permissive | ||||||||
| -r | --restrictive | ||||||||
| -i | --inherited | inherited 9 | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_roots_list | -n | --namespace-fph | <namespace FPH> 2.c |
List the root namespaces by FPH and HRN to STDOUT (one per line, tab-separated). |
n | n | y | y | y |
| -u | --identity-fph | <user identity FPH> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_namespace_tree_show | -n | --namespace-fph | <namespace FPH> 2.c |
Show the entire namespace tree below any namespace specified by FPH. Each namespace is identified by both FPH and HRN. 18 Output to STDOUT. 18 |
n | n | y | y | y |
| --json 18 | ||||||||
| --human-readable 18 | ||||||||
| --show-fph 18 | ||||||||
| -u | --identity-fph | <user identity FPH> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| primitive functions | ||||||||
| nests_nspath_to_fph 3.a | --hrnsp | <namespace path> 2.a |
Convert namespace 2.a path to FPH 2.b (STDOUT) 3. The namespace path string is taken from STDIN unless provided as a parameter.
Return FPH 2.b to STDOUT if namespace string
is valid.
|
y | y | y | y | y |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_fph_to_nspath 3.a | --fph | <FIP> |
Convert FIP 2.b (STDIN) to namespace path (STDOUT). 3
Return namespace path string if FPH 2.b is
valid.
|
y | y | y | y | y |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_entity_type_from_fph | --fph | <FPH> 2.c | Get entity type (STDOUT) identified by FPH 2.c (STDIN). | y | y | y | y | y |
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_entity_add_stewards | --fph | <entity FPH> 2.c | Add one or more steward(s) to the entity. | y | y | y | y | y |
| -s | --steward | <steward FPH> 2.c, 17 [1 or more] | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_entity_remove_stewards | --fph | <entity FPH> 2.c | Remove one or more steward(s) from the entity. | y | y | y | y | y |
| -s | --steward | <steward FPH> 2.c, 17 [1 or more] | |||||||
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_entity_examine | --fph | <entity FPH> 2.c | Get details (JSON > STDOUT) of entity from FPH 2.c (STDIN). | y | y | y | y | y |
| -u | --identity-fph | <user identity FPH> 2.c | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| other | ||||||||
| nests_json_to_csv | -p | --auth | <authentication code> 4.2.c | Converts a NESTS JSON export (STDIN) to CSV (STDOUT). | y | y | y | y | y |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_csv_to_json | -p | --auth | <authentication code> 4.2.c | Converts a NESTS import 13 file from CSV (STDIN) to JSON (STDOUT). | y | y | y | y | y |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_dump_all 13 | -p | --auth | <authentication code> 4.2.c | Create a dump 2.a (JSON) of all entities under the stewardship 5 of the identity invoking the command. Output to STDOUT. | n | n | y | y | n |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_import_tree 13 | -p | --auth | <authentication code> 4.2.c |
Import a tree of specifications 2.a (JSON) defining a tree of entities of any type. Input from STDIN. |
n | n | n | n | y |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_validate_import_tree 13 | -y | --type | CSV | JSON |
Return TRUE if input file (CSV or JSON) is valid. |
y | y | y | y | y |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_requests_list_pending | --accounts | List all pending requests for which the invoking identity has (or shares) stewardship 5. | n | n | y | y | y | |
| --currencies | ||||||||
| --namespaces | ||||||||
| --primary-identities | ||||||||
| --secondary-identities | ||||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_nodes_list_available | -p | --auth | <authentication code> 4.2.c | List the nodes (hosts) across which this namespace tree is replicated. | n | n | n | y | n |
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_contact_identity | -U | --recipient-hrn | <username> 2.a |
Send a message to an identity. By default, identities do not receive messages sent by other identities (only those generated by the NESTS system) but they may opt to do so. Each identity can set its own policy for the receipt of messages. 15 An identity can also blacklist individual identities by FPH. 15 |
y | y | y | y | y |
| -R | --recipient-fph | <recipient identity FPH> | |||||||
| -H | --message | <message> | |||||||
| -e | --email | <sender's email address> | |||||||
| -T | --phone | <sender's mobile phone number> | |||||||
| -F | --surname | <sender's surname> | |||||||
| -G | --forenames | <sender's forename(s)> | |||||||
| -u | --sender-fph | <sender's identity FPH> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests_contact_entity_steward | -K | --entity-fph | <entity FPH> |
Send a message to the stewards of an entity. Each collective of stewards can set its own policy for the receipt of messages. 16 |
y | y | y | y | y |
| -L | --subject-class 16 | <message> | |||||||
| -H | --message | <message> | |||||||
| -e | --email | <sender's email address> | |||||||
| -T | --phone | <sender's mobile phone number> | |||||||
| -F | --surname | <sender's surname> | |||||||
| -G | --forenames | <sender's forename(s)> | |||||||
| -u | --sender-fph | <sender's identity FPH> | |||||||
| -p | --auth | <authentication code> 4.2.c | |||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
| nests | -W | --list-commands |
Get general information about the NESTS CLI.
|
y | y | y | y | y | |
| -X | --help-all-cli | ||||||||
| --about-nests | ||||||||
| --alternative-access | ||||||||
| -g | --hub-information | ||||||||
| -h | --help | ||||||||
| -v | --version | ||||||||
|
Notes for Table 1
|
||||||||
These are typically use with | (pipe), > (redirection) and tee in shell scripts, e.g.
echo namespace-path > nests_path_to_fip
echo namespace-path > nests_path_to_fip | nests_entity_examine
A custom filter (perhaps written in Python, Perl, AWK or Ruby, or using JQ) can be used to extract and process the output of nests_entity_examine.
These functions can be executed remotely over SSH, with or without a wrapper script at the server end. For example:
A local alias such as
alias ompay='ssh -p 31416 u6ca9f438d27a10d7@omhub.lrc.org.uk pay'
can be used as
ompay greendragon.henry.crun.wherever.he.might.be 5.86
where "greendragon" is an account belonging to
identity (whether primary or
secondary) henry.crun.wherever.he.might.be.
The currency to which "greendragon" belongs is defined in the account "greendragon.henry.crun.wherever.he.might.be" and the payment is made if and only if the account holder owning the SSH login account identified by "u6ca910d7@omhub.lrc.org.uk" also has an account in the same currency. Otherwise an error message is returned to STDOUT.
Here "31416" is the port assigned to SSH for this purpose on the host at omhub.lrc.org.uk and u6ca910d7 is the username generated automatically (and generally known only to) the identity owning the paying account.
The payment is authorized like any other SSH action, either by key (preferred) or by entering a password when prompted.
The corresponding script (created automatically, and optionally, for the identity) of this payer's account (named "pay" for consistency with the example above) might look like like
#!/bin/sh
AUTHENTICATION_CODE=8bf77109ca2e37d0
# The payee's account:
TO=$1
AMOUNT=$2
# Identify the currency associated with this account:
CURRENCY=`echo $TO | nests_nspath_to_fph | nests_entity_examine`
# Identify the payer's account using the same currency:
FROM=nests_fip_account_in_currency $CURRENCY
# If the payer has an account in the same currency as that specified
# for the payee then the payment is made:
if $CURRENCY; then
nests_pay -f $FROM -t $TO -a $AMOUNT -p $AUTHENTICATION_CODE
return 0
else
return 1
fi
Version 0.51 - 2021-09-28 12:45 - Copyright © 2021 John Waters