Glossary

Area	Term	Type	Description	Examples
CLI	rivery-cli			pip install rivery-cli pip install -U rivery-cli pip uninstall rivery-cli
CLI	auth	File	auth file lists all the configurations of all the profiles. It is created once you use "Rivery configure". By default a default profile is created, but multiple profiles can be added to the file. Includes: host, region, and token for each profile - auth configuration can be used actoss ALL your projects
CLI	rivery	Command	Main Rivery CLI
CLI	version	Option	Rivery CLI versionn (Rivery CLI, version 0.1)	rivery --version
CLI	region	Option	The region of the profile to connect
CLI	profile	Option - TEXT	Profile is a type of configuration. You can create and use multiple profiles to import/push/run rivers across different accounts and different environments	rivery configure --profile=test rivery rivers import --riverId=123 --profile=test rivery rivers push --paths=test --profile=demo
CLI	host	Option - TEXT	Host is the URL of the environment you are pointing to	https://console.rivery.io
CLI	debug		Show debug log
CLI	ignoreErrors		Ignore errors during run
CLI	rivery initi	Command	Initialize the rivery cli for the first time
CLI	rivery configure	Command	Command to create a new profile: you can add --profile to specify a name, otherwise a default profile will be updated/created	rivery configure --profile=test
CLI	profile	Option - TEXT	Profile is a type of configuration. You can create and use multiple profiles to import/push/run rivers across different accounts and different environments	rivery configure --profile=test rivery --profile=test rivers import riverId=123 rivery --profile=demo rivers push --path=test<br>
CLI	rivery rivers import	Command	This option is used to import a logic river from Rivery account to yaml	rivery --profile=test rivers import --groupName=Test Group
CLI	path	Option - TEXT	The path (under models folder) you want to import the rivers yamls to	rivery rivers import --groupName=Test Group --path=cli\_logics
CLI	riverId	Option - TEXT	The river id to import (can be found the URL) https://console.rivery.io/#/river///river/	rivery rivers --profile=dev import --riverId=605508e44cd57211111111 --path=test1
CLI	groupName	Option - TEXT	The Group name / Kit name	rivery rivers import --groupName=My Group --path=test1
CLI	rivery rivers run fire	Command	Run a river within the current profile (account_environment). Returns runId
CLI	riverId	Option - TEXT	Run by riverId https://console.rivery.io/#/river///river/	rivery rivers run fire --riverId=605508e44cd57211111111
CLI	waitForEnd		Check river status every few seconds until it completes	rivery rivers run fire --riverId=605508e44cd57211111111 --waitForEnd
CLI	timeout	Option - INTEGER	The number of seconds to wait for the run to complete until timing out (default timeout is 2 hours)	rivery rivers run fire --riverId=605508e44cd57211111111 --waitForEnd --timeout=10
CLI	entityName	Option - TEXT
CLI	rivery rivers run status	Command	Check the run status by runId
CLI	runId	Option - TEXT	Returns the current river execution status	rivery rivers run status --runId=605508e44cd57211111111
CLI	waitForEnd	Option	Check river status every few seconds until it completes	rivery rivers run status --runId=605508e44cd57211111111 --waitForEnd
CLI	timeout	Option - INTEGER	The number of seconds to wait for the run to complete until timing out (default timeout is 2 hours)	rivery rivers run status --runId=605508e44cd57211111111 --waitForEnd --timeout=10
CLI	rivery rivers push	Command
CLI	paths	Option - TEXT	--paths TEXT Provide the yaml, or base path to push [required]	rivery rivers push --paths=test rivery rivers push --paths=test/604f3221a3b1ad2c92c6419b.yaml rivery --profile=dev rivers push --paths=test1/605508e44cd57211111111.yaml
YAML Project	!sql	Reference	reference to sql file (under sqls directory), instead of having the SQL inline in the yaml file.	!sql mysql.sql
YAML Project	!ref	Reference	reference to other yaml entities - such as action variables	!ref action\_vars.yaml
YAML Project	!map	Reference	reference to field mapping	!map