Command

nylas audit config show

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

Written by Qasim Muhammad Staff SRE

What does nylas audit config show do?

The nylas audit config show command displays every audit setting in effect — log file path, retention period, max file size, daily rotation, compression, and whether request IDs and API details are recorded. Use it to verify your audit setup before enabling logging or to troubleshoot why logs aren't appearing where expected.

Usage

nylas audit config show

Flags

FlagDescription
--jsonOutput as JSON
--no-colorDisable color output
--verbose(-v)Enable verbose output
--configCustom config file path
--help(-h)Show help for the command
--limitLimit results (most list commands)
--yes(-y)Skip confirmations

Examples

The nylas audit config show command displays every audit setting in effect — log file path, retention period, max file size, daily rotation, compression, and whether request IDs and API details are recorded.

Display current audit configuration

nylas audit config show

Check configuration as JSON for scripting

nylas audit config show --json

Example output

Audit Configuration

  Enabled:         true
  Log directory:   ~/.config/nylas/audit
  Retention:       90 days
  Max size:        100 MB
  Rotate daily:    true
  Stored entries:  142  (1.2 MB)

Troubleshooting

Config shows default values after running set

Ensure you ran `nylas audit config set <key> <value>` with a valid key. Run `nylas audit config show` again to confirm.

Permission denied reading config

Check file permissions on ~/.config/nylas/. The CLI needs read access to display the configuration.

Recommended guides

Run nylas audit config show --help for full help output.