Skip to content

commands.md

Latest commit

 

History

History
204 lines (151 loc) · 6.45 KB

commands.md

File metadata and controls

204 lines (151 loc) · 6.45 KB
Raw

Command Reference

Complete reference for all gac commands.

Global Commands

Command Description
gac --help Show help for gac
gac version Show version information and build details
gac completion Generate shell completion scripts
gac config Configuration management commands

User Commands

Command Description
gac user create [email] Create a new user
gac user list [email] List users or get details for specific user
gac user update [email] Update user information
gac user suspend <user-email> Suspend a user account
gac user unsuspend <user-email> Unsuspend (restore) a user account

See: User Management Guide

Group Commands

Command Description
gac group list [email] List groups or get details for specific group

See: Group Management Guide

Group Settings Commands

Command Description
gac group-settings list <group-email> View group settings
gac group-settings update <group-email> Update group settings

See: Group Settings Guide

Calendar Commands

Command Description
gac calendar create [email] Create a calendar event
gac calendar list [email] List calendar events
gac calendar update [email] Update a calendar event

See: Calendar Operations Guide

Calendar Resource Commands

Command Description
gac cal-resource list List calendar resources (rooms, equipment)
gac cal-resource create <resource-id> Create a new calendar resource
gac cal-resource update <resource-id> Update a calendar resource
gac cal-resource delete <resource-id> Delete a calendar resource

See: Calendar Resources Guide

Organizational Unit Commands

Command Description
gac ou list [ou-path] List organizational units
gac ou create <ou-path> Create a new organizational unit
gac ou update <ou-path> Update an organizational unit
gac ou delete <ou-path> Delete an organizational unit

See: Organizational Units Guide

Alias Commands

Command Description
gac alias list <user-email> List aliases for a user
gac alias add <user-email> <alias-email> Add an alias to a user
gac alias remove <user-email> <alias-email> Remove an alias from a user

See: Alias Management Guide

Version Command

Command Description
gac version Show version information
gac version --short Show version number only

The version command displays:

  • Version number (e.g., v0.5.0 or dev)
  • Git commit hash
  • Build date and time
  • Built by (make or goreleaser)
  • Go version
  • OS/Architecture

Config Commands

Command Description
gac config validate Validate configuration and credentials

The config validate command checks:

  • Configuration file syntax (YAML)
  • Domain format and presence
  • Client secret file existence and permissions
  • Cache file path and permissions
  • OAuth2 token validity

Completion Commands

Command Description
gac completion bash Generate bash completion script
gac completion zsh Generate zsh completion script
gac completion fish Generate fish completion script

See: Shell Completion Guide

Audit Commands

Command Description
gac audit export Export audit logs for a specific application

Audit Export Flags

Flag Description
--app <application> Application type (required: admin, login, drive, calendar, groups, etc.)
--start-time <time> Start time in RFC3339 format (default: 24 hours ago)
--end-time <time> End time in RFC3339 format (default: now)
--user <email> Filter by user email address
--event-name <event> Filter by event name (can specify multiple)
--actor-ip <ip> Filter by actor IP address
-o, --output <format> Output format (json, csv) (default: json)
-f, --output-file <path> Output file path (default: stdout)
--max-results <number> Maximum number of results to return

Supported Application Types

  • admin - Admin console activities
  • login - User login/logout activities
  • drive - Google Drive operations
  • calendar - Calendar activities
  • groups - Google Groups operations
  • mobile - Mobile device activities
  • token - OAuth token activities
  • groups_enterprise - Groups for Enterprise
  • saml - SAML authentication
  • chrome - Chrome browser management
  • gcp - Google Cloud Platform
  • chat - Google Chat
  • meet - Google Meet

See: Audit Logs Guide

Transfer Commands

Command Description
gac transfer --from [email] --to [email] Transfer data ownership

Global Flags

All commands support the following global flags:

Flag Description
--domain <domain> Google Workspace domain
--client-secret <path> Path to OAuth2 client secret file
--cache-file <path> Path to token cache file
-y, --yes Skip all confirmation prompts (use with caution)
-v, --verbose Enable verbose/debug logging
--log-level <level> Set log level (debug, info, warn, error)
--json-log Output logs in JSON format
-h, --help Show help for command

Note on --yes flag: This flag skips all confirmation prompts for destructive operations. Use with extreme caution, especially in production environments. This is useful for automation and scripting where interactive prompts are not possible.

Getting Detailed Help

For detailed help on any command, use the --help flag:

# Get help on a specific command
gac user create --help

# Get help on a command group
gac user --help

# Get help on subcommands
gac group-settings update --help

Related Documentation