CLI Authentication

Authenticate your CLI tool with your Zid partner account.

Description

The login command initiates the authentication process, enabling you to connect your CLI tool with your Zid partner account. Authentication is required to access most zid-theme commands.

Usage

$ zid-theme login

Authentication Process

1. Run the Command:

   $ zid-theme login
   

2. Local Server Initialization:
   • A local Express server starts on port 4444.
3. Browser Redirect:
   • Your default web browser automatically opens, directing you to the Zid Partner Dashboard.
4. Log in:
   • Use your Zid partner account credentials to log in.
5. Redirect & Completion:
   • After successful login, the dashboard redirects you back to the local server.
6. Token Storage:
   • The CLI tool securely stores your authentication tokens locally.

:::note[]

Important Notes

• An active internet connection is required.
• Ensure port 4444 is available on your machine. If it's in use by another application, the authentication flow may not work.
• Your login session is stored locally and securely. You won’t need to log in again unless:
  • Your session expires.
  • You manually log out.
    :::

Example Workflow

$ zid-theme login

1. Output:

   Starting authentication process...
   Opening Zid Partner Dashboard in your default browser...
   Waiting for authentication...
   

2. Final Output:

   Successfully authenticated! You can now use zid-theme commands.
   

Troubleshooting

If you encounter issues during the login process, try the following:

:::caution[]

Security

• Your authentication tokens are stored securely on your local machine.
• To protect your account information:
  • Always use the official zid-theme CLI tool.
  • Keep your system secure.
    :::

:::info[]

Learn More

For more information on theme development and deployment, refer to the Zid Theme Development Documentation.
:::