-
Notifications
You must be signed in to change notification settings - Fork 41
docs: add simplified install guide for admins #1483
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
+98
−0
Closed
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| of use cases. For a detailed reference of the install command check | ||
| [the full install guide](installation.md). | ||
|
|
||
| ## Google Cloud Platform (GCP) Project | ||
|
|
||
|
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 | ||
| ``` | ||
|
|
||
|
rh-hemartin marked this conversation as resolved.
|
||
| This creates the appropriate secrets, variables and files in your repository. | ||
|
rh-hemartin marked this conversation as resolved.
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: | ||
|
|
||
|
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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.