Connect your code | Faustine Docs

Connect your code is the step of the Quick start wizard where you choose the repository a Web Agent is built from. Faustine asks for read access to the code.

The repository is fixed once the agent is created. To build an agent from another repository, create another agent.

Before you begin

You are on the Connect your code step of the wizard.
You can authorize access to the repository in GitHub, GitLab or Bitbucket. If you cannot, upload a ZIP.

Connect an account

A connection is the access your workspace has to one account or organization at a provider. Connections are shared by every agent in the workspace, so you connect each account once.

To connect an account:

Select GitHub, GitLab or Bitbucket. The connections your workspace already has for that provider are listed.
Select a connection, or select Connect GitHub, Connect GitLab or Connect Bitbucket to add one.
Approve the access at the provider. For GitHub, you install the Faustine GitHub App and choose the repositories it can read.

The provider sends you back to the wizard with what you entered in the earlier steps, and the new connection is selected.

On GitHub, you can select use a Personal Access Token instead and paste a token with read access to the repositories. Faustine stores the token encrypted.

For the permissions each provider asks for, see Connect GitHub, Connect GitLab and Connect Bitbucket.

Choose the repository, the branch and the folder

To point the agent at your front-end code:

In Repository, select the repository. To type it instead, select Enter owner/repo manually.
In Branch, select the branch to analyze. The repository's default branch is selected for you.
In Frontend path, select the folder that holds the front-end code if the repository also holds a backend or other apps. Leave Repository root otherwise.
In Anything we should know about this app?, enter what the code does not say: the words your team uses for things, sections to skip, how authentication behaves. The analysis reads these notes before it reads the code.
Select Continue.

The step closes and shows the repository, the branch and the folder.

You can change the notes later in the agent's Settings tab, under Analysis notes. A change applies from the next analysis or update.

Troubleshooting

Symptom	Cause	Fix
Installation requested appears at the top of the wizard	You do not have permission to install the GitHub App on that organization, and GitHub asked its owners.	After an owner approves, open the step again and select the connection.
Couldn't load repositories appears under the list	The provider did not return the list for that connection.	Select Enter owner/repo manually and type the repository as `owner/repository`.
The repository is not in the list	The connection was not given access to it.	At the provider, add the repository to the access you granted, or connect the account that owns it.
A folder shows not found on this branch	The folder you chose does not exist on the selected branch.	Select another folder or another branch.

Next steps

Upload a ZIP instead of a repository: when the repository cannot be connected.
Add reference repositories and API docs: let the analysis read your backend too.
Keep the agent up to date: what happens on each push to the connected branch.