Joule Command Line Interface (CLI)
How to interact with a Joule node from the command line.
joule
Usage:
Options:
-n, --node TEXT override the default node (see joule node list)
--version Show the version and exit.
--help Show this message and exit.
joule admin
Administer the local node. All commands requires superuser (sudo) privilege to run.
Usage:
Options:
joule admin authorize
Grant a local user CLI access. Use sudo -E to store the credentials in the current user's
environment. Otherwise this command will grant the root user CLI access (credentials will be stored in /root/.joule).
Usage:
Options:
-c, --config TEXT main configuration file
-u, --url TEXT joule API URL (optional)
--help Show this message and exit.
joule admin erase
Erase ALL data on the local node. May also delete authorization for masters (API users and Lumen connections) and follower nodes.
Danger
This command cannot be undone, use with caution!
Usage:
Options:
-c, --config TEXT main configuration file
-l, --links delete masters and followers as well as data
--yes automatically confirm operation
--help Show this message and exit.
joule admin initialize
Run initial system configuration. This command will perform the following operations:
- Create a set of default configuration files in
/etc/joule - Enable and start a systemd service
/etc/systemd/system/joule.service - Provision a system user account named
jouleto run the systemd service.
Use command line flags to override the system defaults.
Usage:
Options:
--dsn TEXT PostgreSQL DSN [required]
--bind TEXT IP address (0.0.0.0 for all)
--port TEXT TCP port (default is 8080)
--name TEXT Node name (default is random)
--generate-user-file Create file for dynamically managing users
--help Show this message and exit.
joule archive
Manage Joule archives. See [archive docs] for more information on importing and exporting archive data
Usage:
Options:
joule archive inspect
Display the contents of an archive
Usage:
Options:
joule archive upload
Upload archive(s) to a Joule node
Usage:
Options:
-f, --flush remove archives after successful upload
-e, --quit-on-error quit upload on error
-v, --verbose display info messages
--help Show this message and exit.
joule data
Interact with data streams.
Usage:
Options:
joule data filter
Filter stream data.
Usage:
Options:
joule data filter mean
Apply a moving average (mean) filter.
Usage:
Options:
-w, --window INTEGER window size [required]
--start TEXT timestamp or descriptive string
--end TEXT timestamp or descriptive string
--help Show this message and exit.
joule data filter median
Apply a median filter.
Usage:
Options:
-w, --window INTEGER window size [required]
--start TEXT timestamp or descriptive string
--end TEXT timestamp or descriptive string
--help Show this message and exit.
joule event
Manage event streams.
Usage:
Options:
joule event copy
Copy events to a different stream.
Usage:
Options:
-s, --start TEXT timestamp or descriptive string
-e, --end TEXT timestamp or descriptive string
-a, --action [ignore|replace|prompt]
action to take if events already exist in
the destination
-n, --new copy starts at the last timestamp of the
destination
-d, --destination-node TEXT node name
--help Show this message and exit.
joule event info
Display event stream information.
Usage:
Options:
joule event move
Move an event stream to a different folder.
Usage:
Options:
joule event rename
Rename an event stream.
Usage:
Options:
joule folder
Manage folders.
Usage:
Options:
joule folder copy
Recursively copy a folder to a new, empty location
Usage:
Options:
-s, --start TEXT timestamp or descriptive string
-e, --end TEXT timestamp or descriptive string
-d, --destination-node TEXT
--help Show this message and exit.
joule folder delete
Delete a folder and all contents.
Usage:
Options:
joule folder list
Display folder hierarchy (directory layout).
$> joule stream list
├── demo
│ ├── f1
│ │ └── stream0(1)
│ ├── copied2(6)
│ ├── copy one(5)
│ └── stream1(4)
└── random
├── 10hertz(3)
├── output(2)
└── output2(7)
Usage:
Options:
-l, --layout include stream layout
-s, --status include stream status
-i, --id show ID's
--help Show this message and exit.
joule folder move
Move a folder to a new location.
Usage:
Options:
joule folder rename
Rename a folder.
Usage:
Options:
joule follower
Manage node followers.
Usage:
Options:
joule follower delete
Remove a follower
Usage:
Options:
joule follower list
Display node followers
Usage:
Options:
joule master
Manage node access.
Usage:
Options:
joule master add
Authorize a new node master.
For users specify a username (for documentation only). For joule/lumen masters specify an domain name or IP address. If the master node is not hosted at the default location, specify the full URL.
Usage:
Options:
-k, --key TEXT desired API key, must be 32 characters, omit
for a random key
-u, --remote-access-url TEXT URL for remote access to this node, omit to
automatically detect
--help Show this message and exit.
joule master delete
Revoke access for a user or Joule/Lumen node.
Specify the type of master and the name as displayed by the 'master list' command
Usage:
Options:
joule master list
Display all users and nodes with access to the current node.
Usage:
Options:
joule module
Retrieve module information.
Usage:
Options:
joule module info
Display module information
Usage:
Options:
joule module list
List currently executing modules
Usage:
Options:
joule module logs
Display a module's log output
Usage:
Options:
joule node
Configure local settings.
Usage:
Options:
joule node add
Add a new node (requires API key)
Use the information provided by 'joule master add user'
Usage:
Options:
joule node default
Change the default node.
Usage:
Options:
joule node delete
Remove a node.
Usage:
Options:
joule node info
Display information about a node.
Usage:
Options:
joule node list
Display authorized nodes.
Usage:
Options:
joule proxy
Proxied site information.
Local URL's proxied by Joule.
Usage:
Options:
joule proxy info
Display proxy information
Usage:
Options:
joule proxy list
Display all configured proxies
Usage:
Options:
joule stream
Manage data streams.
Usage:
Options:
joule stream annotations
Display stream annotations.
Usage:
Options:
-s, --start TEXT timestamp or descriptive string
-e, --end TEXT timestamp or descriptive string
-c, --csv display in raw csv format
--delete remove annotations for this stream
--help Show this message and exit.
joule stream delete
Delete a data stream
Usage:
Options:
joule stream info
Display stream information.
Usage:
Options:
joule stream move
Move a data stream to a different folder
Usage:
Options:
joule stream rename
Rename a data stream.
Usage:
Options: