Skip to content
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Structure decided in [ADR 0023](../ADRs/0023-user-documentation-structure.md).

Guides for org administrators who install, configure, and manage fullsend.

- [How to install fullsend](admin/install.md) — A simplified version of the installation guide.
- [Installing fullsend](admin/installation.md) — Set up fullsend in a GitHub organization from scratch (see [#328](https://github.com/fullsend-ai/fullsend/pull/328))
- [Enabling fullsend on private repositories](admin/private-repositories.md) — Additional guardrails and configuration for private repos

Expand Down
97 changes: 97 additions & 0 deletions docs/guides/admin/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# How To Install Fullsend

## Overview

This guide explains how to install Fullsend, both in organization and repository mode.
We recommend using repository mode as it is simpler.

Note: this guide is not intended to be a reference for the installation parameters.
It is intended to a be simplified version to help you get started and that covers most
Comment thread
rh-hemartin marked this conversation as resolved.
Outdated
of use cases. For a detailed reference of the install command check
[the full install guide](installation.md).

## Google Cloud Platform (GCP) Project

Comment thread
rh-hemartin marked this conversation as resolved.
Fullsend needs a GCP Project to connect run the inference. Create it and then enable the following
APIs:

* [Agent Platform](https://console.cloud.google.com/apis/library/aiplatform.googleapis.com).
* [IAM Credentials](https://console.cloud.google.com/apis/library/iamcredentials.googleapis.com).
* [Cloud Resource Manager](https://console.cloud.google.com/apis/library/cloudresourcemanager.googleapis.com).

## Local Tools and CLIs

* Download and authenticate with [`gh`](https://cli.github.com/).
* Download and authenticate with [`gcloud`](https://cloud.google.com/cli).
* Download [`fullsend` CLI](https://github.com/fullsend-ai/fullsend/releases).

## Install Fullsend GitHub Applications

Install (or request the installation of) the official Fullsend GitHub applications
into your organization scoped to the repositories you want:

* [fullsend-ai-coder](https://github.com/apps/fullsend-ai-coder)
* [fullsend-ai-triage](https://github.com/apps/fullsend-ai-triage)
* [fullsend-ai-fullsend](https://github.com/apps/fullsend-ai-fullsend)
* [fullsend-ai-retro](https://github.com/apps/fullsend-ai-retro)
* [fullsend-ai-review](https://github.com/apps/fullsend-ai-review)

You can continue with the installation, but fullsend won't work until those applications
get installed.

## Export Variables (optional)

The commands on this how-to use the bash variable expansion notation to indicate
that you should provide your own values. If you want, you can export these variables
and then copy-paste the commands, otherwise you need to edit the commands before
executing them. Run the following code:

```bash
export ORG_NAME="<your-org-name>"
export REPO_NAME="<a-repository-within-that-org>"
export GCP_PROJECT="<your-gcp-project-slug>"
```

## Repository mode installation (recommended)

<!-- TODO: --mint-url and --skip-mint-check will be the default in the future so they will need to be removed from here -->
```bash
fullsend admin install $ORG_NAME/$REPO_NAME --inference-project $GCP_PROJECT --mint-url=https://fullsend-mint-gljhbkcloq-uc.a.run.app --skip-mint-check
```

Comment thread
rh-hemartin marked this conversation as resolved.
This creates the appropriate secrets, variables and files in your repository.
Comment thread
rh-hemartin marked this conversation as resolved.
Comment thread
rh-hemartin marked this conversation as resolved.

## Organization mode installation

<!-- TODO: --mint-url and --skip-mint-check will be the default in the future so they will need to be removed from here -->
```bash
fullsend admin install $ORG_NAME --inference-project $GCP_PROJECT --mint-url=https://fullsend-mint-gljhbkcloq-uc.a.run.app --skip-mint-check --enroll-none
```

This creates the appropriate secrets, variables and files in your organization and repositories.
After installing, enroll the repositories you want with:

Comment thread
rh-hemartin marked this conversation as resolved.
```bash
fullsend admin enable repos $ORG_NAME $REPO_NAME
```

## Test Fullsend

By default Fullsend will:

* Triage new issues or triage on demand with `/fs-triage` on an issue.
* Implement changes for bugfixes (flagged by triage) or on demand with `/fs-code` on an issue.
* Review changes on new PRs or on demand with `/fs-review` on a PR.
* Automatically address PR feedback (for bot users) or on demand with `/fs-fix` on a PR.
* Analyze execution and discussions when a PR closes (merged or closed) or on demand with `/fs-retro` on
a PR.

## Next steps

Explore our documentation to see:

* How to customize default agents.
* How to provide skills for agents.
* How to provide custom agents.
* How to run agents locally.
* How to provide your own GitHub applications.
Loading