diff --git a/docs/reference/ymir-cli.md b/docs/reference/ymir-cli.md index 81f2802..0e07bfc 100644 --- a/docs/reference/ymir-cli.md +++ b/docs/reference/ymir-cli.md @@ -1483,6 +1483,53 @@ The timezone to display the log times in. $ ymir environment:logs:query --timezone=America/New_York +### environment:logs:watch + +
+$ ymir environment:logs:watch [options] [<environment> [<function>]]
+
+ +Continuously monitor and display the most recent logs for an environment function. + +#### Arguments + +##### `environment` (default: staging) + +The name of the environment to get the logs of. + +##### `environment` (default: website) + +The environment function to get the logs of. + +#### Options + +##### `--interval=INTERVAL` (default: 30) + +Interval (in seconds) to poll for new logs. + +##### `--timezone=TIMEZONE` + +The timezone to display the log times in. + +#### Usage + +
+# Continuously monitor and display the most recent logs from the "website" function of the "staging" environment
+$ ymir environment:logs:watch
+
+# Continuously monitor and display the most recent logs from the "website" function of the "production" environment
+$ ymir environment:logs:watch production
+
+# Continuously monitor and display the most recent logs from the "console" function of the "production" environment
+$ ymir environment:logs:watch console
+
+# Continuously monitor and display the most recent logs from the "website" function of the "staging" environment while polling every minute
+$ ymir environment:logs:watch --interval=60
+
+# Continuously monitor and display the most recent logs from the "website" function of the "staging" environment displayed in the New York timezone
+$ ymir environment:logs:watch --timezone=America/New_York
+
+ ### environment:metrics