Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

FOKS Command Line Basics

For a overview of all the commands.

PS> foks --help

For the FOKS Key-Value Store commands, one is dealing with a structure that is nearly identical to that of dealing with file systems.

All Key/Value paths start with the root path / and the last node or value in the path is called the Key.

For instance, /mynode/tom/api, api is the key to the associated value assigned to it. The simplest command to create this keypath is:

PS> foks kv put /mynode/tom/api apivalue -p --force

The keypath is /mynode/tom/api where api is the key and apivalue is the value assigned to the key.

The -p flag will create all missing names in the path if needed and –force flag will overwrite that keypath if it already exists.

To retrieve the value in this keypath:

PS> foks kv get /mynode/tom/api
apivalue

To list all existing kv paths.

PS> foks kv ls /