Reference

`gog calendar events`

gog calendar events

Generated from gog schema --json. Do not edit this page by hand; run make docs-commands.

List events from a calendar or all calendars

#Usage

gog calendar (cal) events (list,ls) [<calendarId> ...] [flags]

#Parent

#Flags

FlagTypeDefaultHelp
--access-tokenstringUse provided access token directly (bypasses stored refresh tokens; token expires in ~1h)
-a
--account
--acct
stringAccount email for API commands (gmail/calendar/chat/classroom/drive/docs/slides/contacts/tasks/people/sheets/forms/appscript/ads)
--allboolFetch events from all calendars
--all-pages
--allpages
boolFetch all pages
--cal[]stringCalendar ID or name (can be repeated)
--calendarsstringComma-separated calendar IDs, names, or indices from 'calendar calendars'
--clientstringOAuth client name (selects stored credentials + token bucket)
--colorstringautoColor output: auto|always|never
--daysint0Next N days (timezone-aware)
--disable-commandsstringComma-separated list of disabled commands; dot paths allowed
-n
--dry-run
--dryrun
--noop
--preview
boolDo not make changes; print intended actions and exit successfully
--enable-commandsstringComma-separated list of enabled commands; dot paths allowed (restricts CLI)
--fail-empty
--non-empty
--require-results
boolExit with code 3 if no results
--fieldsstringComma-separated fields to return
-y
--force
--assume-yes
--yes
boolSkip confirmations for destructive commands
--fromstringStart time (RFC3339 with timezone, date, or relative: today, tomorrow, monday)
--gmail-no-sendboolfalseBlock Gmail send operations (agent safety)
-h
--help
kong.helpFlagShow context-sensitive help.
-j
--json
--machine
boolfalseOutput JSON to stdout (best for scripting)
--max
--limit
int6410Max results
--no-input
--non-interactive
--noninteractive
boolNever prompt; fail instead (useful for CI)
--page
--cursor
stringPage token
-p
--plain
--tsv
boolfalseOutput stable, parseable text to stdout (TSV; no colors)
--private-prop-filterstringFilter by private extended property (key=value)
--querystringFree text search
--results-onlyboolIn JSON mode, emit only the primary result (drops envelope fields like nextPageToken)
--select
--pick
--project
stringIn JSON mode, select comma-separated fields (best-effort; supports dot paths). Desire path: use --fields for most commands.
--shared-prop-filterstringFilter by shared extended property (key=value)
--tostringEnd time (RFC3339 with timezone, date, or relative)
--todayboolToday only (timezone-aware)
--tomorrowboolTomorrow only (timezone-aware)
-v
--verbose
boolEnable verbose logging
--versionkong.VersionFlagPrint version and exit
--weekboolThis week (uses --week-start, default Mon)
--week-startstringWeek start day for --week (sun, mon, ...)
--weekdayboolfalseInclude start/end day-of-week columns

#See Also