← Documentation

PLUXIX GUIDE

GitHub

Connect GitHub once so PLUXIX can discover repositories and create local projects without exposing your token to task context.

Admin setup

An administrator configures the GitHub Client ID and enables Device Flow in the provider settings. The account only needs the permissions required by the configured GitHub application.

  • The Client ID is not a secret; the user token is.
  • A Device Flow scope error means the provider expects permissions from its app configuration.
  • Use the Admin test before asking users to connect.

User connection

Open Connections in the portal or choose GitHub from project selection in the Agent. Start the device flow, enter the code on GitHub and wait for PLUXIX to confirm the account.

  • Users who registered with GitHub should see the same connection automatically when the identity token includes the account data required by PLUXIX.
  • The connection is stored per account and can be revoked from Connections.
  • The Agent should not ask for the GitHub code on every project once the connection is valid.

Repository workflow

Discover a repository, choose a local parent directory and let the Agent create or open the project. Private repository transport may still require Git credentials on that Windows machine. Review branch and status before editing.