Skip to content

1. Preparation

Jump to bottom
sefanja edited this page Jun 20, 2026 · 1 revision

Prepare GitHub

  1. Log onto your GitHub Account at GitHub.com or create a GitHub account at GitHub.com
  2. Please share your GitHub account name by emailing it to OSPO@alliander.com, so that we can add you to the NBility-Model GitHub organization.
  3. Accept the invitation to join the NBility-Model GitHub organization. Note that this process may take some time as it requires manual intervention by the NBility-Model maintainers. In the meantime, you can proceed with step 4.
  4. To configure Archi for Github integration you would need to create a Personal Access Token (PAT) from your user account. For a detailed overview of the process you can visit https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-toke

Alternatively, you can follow the steps below:

Create a Github Personal Access Token (PAT)

  1. Select [Settings] from your account menu (look for the avatar at the right-top of the page)

    coArchi-github-settings

  2. Select [Developer settings] from the menu on the left-hand of the page

    coArchi-github-developer-settings

  3. Select [Personal access tokens] and then [Tokens (classic)]

  4. Select [Generate new token] and then [Generate new token (classic)]

  5. Enter your token name, set the token expiry and select the [repo] scope for the token

    coArchi-new-token

  6. Click [Generate token]

  7. Copy the token from the screen and store it securely for configuration purposes. IMPORTANT: YOU CANNOT RETRIEVE THE TOKEN AFTER IT HAS BEEN GENERATED AND DISPLAYED ON THIS PAGE. IF YOU LOOSE IT YOU WILL NEED TO GENERATE A NEW TOKEN.

    coArchi-personal-access-token

Set Up Archi

Installing Archi

  1. Download and install the latest version of Archi from https://www.archimatetool.com/download/

Download and install the coArchi plug-in

  1. Download the most recent version of coArchi plug-in zip file from the Archi plugins page.

  2. In Archi, select "Manage Plug-ins..." from the main Help menu. From the Plug-ins Manager window, select "Install New..." and select the coArchi plug-in zip file. You may need to restart Archi to activate the plug-in. Please ensure the plug-in version supports the installed version of Archi.

    coArchi-manage-plugins

    coArchi-manage-plugins-window

  3. If your plug-in installation was successful, the [Collaboration] menu item should be visible appear on the application menu in Archi after restarting Archi.

    coArchi-collaborate

Import Model in Archi

Once you have configured Archi and coArchi, and generated your Github Personal Access Token (PAT) you will be able to import the Nbility model into archi.

  1. In Archi, select [Import Remote Model to Workspace] from Collaboration menu. You may need to provide Archi a master password to unlock this feature. IMPORTANT: YOU CANNOT RETRIEVE THE MASTER PASSWORD AFTERWARDS. IF YOU LOOSE IT YOU MAY WILL NEED TO REINSTALL ARCHI.

    coArchi-add-remote-model

  2. In the Add Remote Model modal, provide the following information:

    Field Description
    URL The full web URL of the repo: https://github.com/username/reponame.git
    User Name Your Github user name
    Password The Github Personal Access Token (PAT) you generated earlier

    It is possible that you could use your GitHub credentials as-is in the screen. However, it is recommended that you enable 2FA on your Github account to protect access to the repo. In this case you will only be able to log onto Github from Archi using the Github Personal Access Token (PAT).

    To obtain the repo URL, you can copy of from the Clone address:

    coArchi-clone

Clone this wiki locally