Command: ennote auth

Manage Ennote authentication. Authenticates the developer machine against the Ennote Cloud using an OAuth 2.0 PKCE flow or via headless tokens for CI/CD.

Overview

The auth command group allows you to manage your CLI authentication state and verify your active session.

bash
ennote auth [command]

Available Commands:
  login       Authenticate your CLI session via the Ennote Web UI
  logout      Clear the active Ennote session from your local machine
  status      View your current authentication status

Authentication Methods

1. Interactive SSO (Local Development)

Start the interactive authentication process. This is the standard approach for local developer machines.

bash
ennote auth login

Security & Behavior

  • Browser Integration: Opens the system browser to authenticate via Google/Microsoft/GitHub SSO.
  • Local Handshake: Binds to a local callback port to receive the session token.
  • Zero Persistence: Validates anti-CSRF state parameters and securely stores the token in the OS Keyring, never writing it to disk in plaintext.

2. Headless Token (CI/CD Pipelines)

For automated environments, you can bypass interactive login by setting the ENNOTE_TOKEN environment variable. This overrides the OS Keyring entirely and is the required method for headless execution.

bash
export ENNOTE_TOKEN="your_machine_identity_token"

Viewing Status (ennote auth status)

You can verify your current authentication state, token source, and expiration time using the status command.

bash
ennote auth status

Example Output:

yaml
Ennote CLI Authentication Status
--------------------------------
Status:         Expired
Source:         OS Keyring
Account:        Demo User ([email protected])
Provider:       google.com
Expired At:     2026-06-16 08:52:29

Your session has expired. Please run 'ennote auth login' to authenticate.

Logging Out (ennote auth logout)

To securely remove your active session and wipe the tokens from your local machine's OS Keyring, run the logout command.

bash
ennote auth logout

Need Help?

If you encounter any issues or have questions, don’t hesitate to contact support. Our team is here to assist you with any challenges you might face.

Was this page helpful?

© 2026 Ennote.io. All Rights Reserved.