diff --git a/content/docs/general/tools/cli-client-tools.mdx b/content/docs/general/tools/cli-client-tools.mdx index 927bc5225686f5e31e9ede7cb5ea9c1eb044ce80..cd8b712a7ab242996d6683d33e02a4c78c95761a 100644 --- a/content/docs/general/tools/cli-client-tools.mdx +++ b/content/docs/general/tools/cli-client-tools.mdx @@ -2,23 +2,14 @@ title: "SCS CLI Client Tools" --- -## Configuration - -System wide configuration -> `etc/scs-cli-client-tools/config.toml` -User configuration -> `$XDG_CONFIG_HOME/scs-cli-client-tools/config.toml` - ## it4ifree -`MUNGE_SOCK` - the path to the munged socket. -`CLUSTERNAME` - name of the cluster `it4ifree` is running on. -`API_URL` - set this environment variable to the API address. [default: `https://scs.it4i.cz/api/v2/`] - -```code List project resource usage data from SCS IS. Also available at [https://scs.it4i.cz][a]. -Usage: it4ifree [OPTIONS] +Usage: `it4ifree [OPTIONS]` +```code Options: -p, --percent -P, --project <PROJECT> @@ -69,13 +60,11 @@ Options: ## it4imotd -`API_URL` - set this environment variable to the API address. [default: `http://127.0.0.1:5100/api/v2`] - -```code -The command shows IT4I messages of the day +The command shows IT4I messages of the day. -Usage: it4imotd [OPTIONS] +Usage: `it4imotd [OPTIONS]` +```code Options: -w, --width <WIDTH> [default: 78] -c, --category <CATEGORY> [possible values: public-service-announcement, service-recovered-up, critical-service-down, service-hard-down, auxiliry-service-down, planned-outage, service-degraded, important, notice] @@ -96,18 +85,14 @@ any inconvenience. ## it4ifsusage -`MUNGE_SOCK` - the path to the munged socket. -`CLUSTERNAME` - name of the cluster `it4ifsusage` is running on. -`API_URL` - set this environment variable to the API address. [default: `http://127.0.0.1:5100/api/v2`] - -```code The command shows filesystem usage of IT4I cluster storage systems User quotas are always active, expiration timestamps signify an end of a temporary quota increase. Project quotas are active during the lifetime of a project. -Usage: it4ifsusage [OPTIONS] +Usage: `it4ifsusage [OPTIONS]` +```code Options: -s, --status <STATUS> [default: active] [possible values: active, expired, all] -j, --json Output to json instead of a table @@ -129,9 +114,11 @@ Options: ## it4idedicatedtime -```code -Usage: it4idedicatedtime [OPTIONS] +Retrieves dedicated time entries, optionally filtered by cluster name/status. + +Usage: `it4idedicatedtime [OPTIONS]` +```code Options: -s, --status <STATUS> [default: active] [possible values: active, planned] -c, --cluster <CLUSTER> [default: all] [possible values: all, barbora, karolina, comp-sys, dgx]