Voozh

What does nylas audit export do?

The nylas audit export command writes audit log entries to a JSON or CSV file for compliance reporting, external analysis, or backup before clearing logs. Filter by date range with --since and --until. Pipe to stdout by default, or save to a file with -o. Supports SOC 2 and internal audit workflows.

Usage

nylas audit export [-o FILE] [--format json|csv] [--since DATE]

Flags

Flag	Description
--json	Output as JSON
--no-color	Disable color output
--verbose(-v)	Enable verbose output
--config	Custom config file path
--help(-h)	Show help for the command
--limit	Limit results (most list commands)
--yes(-y)	Skip confirmations
--output(-o)	Output file path (default: stdout)
--format	Export format: json or csv (default: json)
--since	Export entries after this date
--until	Export entries before this date
--limit(-n)	Maximum number of entries to export

Examples

Export to JSON file

nylas audit export -o audit-logs.json

Export as CSV

nylas audit export --format csv -o audit-logs.csv

Export date range

nylas audit export --since "2024-01-01" --until "2024-02-01" -o january.json

Pipe to jq for analysis

nylas audit export | jq '[.[] | .command] | group_by(.) | map({command: .[0], count: length})'

Backup before clearing

nylas audit export -o backup-$(date +%Y%m%d).json
nylas audit logs clear --force

Example output

✓ Exported 142 entries to audit.json
 Format: json
 Range: 2024-01-01 to 2024-01-31

Troubleshooting

Export file is empty

Check that audit logs exist with `nylas audit logs show`. Verify the date range if using --since/--until.

CSV formatting issues

Some fields contain commas. Use --format json for complex log data or a proper CSV parser.

Related commands

nylas audit config set

Set an audit configuration value. Valid keys: retention_days, max_size_mb, rotate_daily, compress_old, log_request_id, log_api_details.

nylas audit config show

Show the current audit configuration, including log path, retention, rotation, and compression settings.

nylas audit init

Initialize audit logging for the Nylas CLI. Creates the log directory, default configuration, and optionally enables logging immediately.

nylas audit logs clear

Clear all audit log entries. This is a destructive action — consider exporting logs first with `nylas audit export`.

nylas audit logs disable

Disable audit logging. Stops recording CLI activity to the audit log file.

nylas audit logs enable

Enable audit logging. Records all CLI activity to a local log file for compliance and debugging.

URL: https://cli.nylas.com/docs/commands/audit-export

⇱ nylas audit export command | Nylas CLI