# Install the Github App
Source: https://docs.fumedev.com/github

Integrate Fume Blazingly Fast

## Setup the Github App

You need to set up the Fume Github App. This will let Fume to make changes in your codebase and submit PRs. Use the following link to install it on your workspace.

<Card title="Install Fume Github App" icon="github" href="https://github.com/apps/fumedev/installations/select_target">
  A friendly AI sfotware engineer for your code chores
</Card>

Rest is very straightforward: Simply select the the organization and repository you want to give Fume access to. Then, you are done!

<img />

### Security

Fume never permanently stores your code. All of your code is deleted from our servers are deleted after the runtime.


# Setup for Gitlab
Source: https://docs.fumedev.com/gitlab

Integrate Fume Blazingly Fast

## Create a Bot Token

The first thing you have to do to setup your GitLab repository for Fume is creating a bot token. You can do so by navigating to your repository page. Then you will have to follow to following Settings > Access Tokens tabs. The tabs can be found in the bottom left opf your window.

<img />

Then, click on the `Add new token` button located at the topn right corner of the tokens table. Follow the steps below to correctly set up your acess token.

#### 1) Set the token name as `fume[bot]`

#### 2) Set the token role `developer`

#### 3) Grant the following scopes: `api`, `read_api`, `read_repository`, `write_repository`

#### 4) Finally, click on the `Create project access token` button

Now, your token must be created. Save the token somewhere, because you will need it for the next step while setting up the Slack app.


# Welcome!
Source: https://docs.fumedev.com/introduction

Everything you need to know to 10x your dev speed

<img alt="Hero Light" />

<img alt="Hero Dark" />

## Setting up

The first thing you have to do is signing up for an account <a href="https://app.fumedev.com/signup"> here </a>

Signing up will give you a 14-day free trial period without requiring any payment information. During the free trial period, you can use Fume to its fullest. If you choose not to continue your subscription after 14 days, you do not need to take any further action. Your subscription will be automatically canceled after the 14 day trial period.

## Connect Your Code Repositories

Will need to access your codebases in order to function properly. We do not permanently store any of piece of your codebase and your data is not used for the training of the models we use.

In order to connect your codebases, you will need go through necessary setup steps depending on your git provider. Fume currently supports Github and GitLab. Our BitBucket integration is coming soon...

<Card title="Github Integration" icon="github" href="/github" />

<Card title="GitLab Integration" icon="gitlab" href="gitlab" />

## Signing In Your Account for the First Time

When you first sing in your accountm, you will be prompted to visit the documentation to learn how to set up your git provider with Fume. If you have already completed this step, you can dismiss the popup bu clicking anywhere else on the screen.

<img />

You will be prompted with an empty chat history and unable to start any tasks. The reason for this is that you did not add any repositories to Fume yet! Next section will guide you through the process of adding your first repository.

## Adding Your First Repository

To add you first repository, click on the 'Add Repo' button in the Home page - marked with red in the image below.

<img />

You will be prompted with a form to enter the relevant information for your repository. You will need to provide the following information:

* Git Provider (Github or Gitlab)
* Org Name
* Repo Name
* Development Branch Name

<img />

Once you have filled in the form, click on the 'Submit' button to add your repository to Fume.

If you are using Github, you will be prompted to enter a personal access token. This token will allow Fume to verify that you really have access to the repository you want to add. You can create a personal access token in your Github settings. The popup screen will include the relevant link and the necessary permission names to do that. When you create one, simply copy and paste the token to the relevant field.

On the other hand, if you are using Gitlab, you will be prompted to enter your Gitlab token and Gitlab URL. This is the token you generated previously in the section <a href="/gitlab">Gitlab Integration</a>. Copy and paste the token you saved from the previous section to the relevant field.

*Team's Note: Some users are reporting a bug where they have to re-enter their repo information after entering the Github access token. If you exeperinece the same issue, we apologize for the inconvinience. Kindly, re-enter the info and all should be good.*

After adding a repository, it might take a few seconds for Fume to verify all of the information you just entered. Wait until the spinner disappears and you get redirected to the 'Settings' page.

In the 'Settings' page, you will be able to see the name of the repository you just added. The status for the newly added repository should be 'PROGRESS'. This means that Fume has started processing your codebase.

<img />

This processing can take a while. Anywhere between 10 minutes to a few hours depending on the size of your codebase. If, anything goes wrong, the status will change to 'FAILIURE'. In that case, please contact us at [contact@fumedev.com](mailto:contact@fumedev.com). Also, Fume's processing should not take more than 6 hours (if you are not uploading the Linux kernel). If it takes longer than that, please contact us from the same email.

When the status of your repository changes to 'SUCCESS', you can now start using Fume! Go back to your 'Home' page and start your first task and select the repository you just added.

## Slack Integration for Your Team (Optional)

If you are using Slack for your team communication, you can connect Fume to your Slack workspace! Everday engineers ask each other many technical questions and they lose time for both answering and searching for the answer. Fume can act as the experienced engineer who understands ever part of your codebase(s). To connect Fume to your Slack workspace and save valuable hours for your team, see the guide below.

<Card title="Slack Integration" icon="slack" href="/slack" />

## Use Cases

Update your docs to your brand and add valuable content for the best user conversion.

<CardGroup>
  <Card title="UI & Copy Changes" icon="palette">
    Submit a task alongside a screenshot, and Fume will implement the necessary UI changes in your product.
  </Card>

  <Card title="Bugs" icon="bug">
    Fume is especially good at debugging your product. Give it the steps to reproduce the bug and a possible solution, Fume will debug the issue.
  </Card>

  <Card title="Error Logs" icon="screwdriver-wrench">
    Connect your Sentry or Datadog logs to a Slack channel and Fume will generate solutions immediately.
  </Card>

  <Card title="New Features" icon="stars">
    You'd be surprised how much can Fume achieve in your codebase. It's doesn't always get fullout features right but it sets a very strong foundation for your team to pick up.
  </Card>
</CardGroup>


# Install the Slack App
Source: https://docs.fumedev.com/slack

Integrate Fume Blazingly Fast

## Setup the Slack App

You need to set up the Fume Slack App. This will let you assign tasks to Fume with image and text descriptions. Use the following link to install it on your workspace.

<Card title="Install Fume Slack App" icon="slack" href="https://slack.fumedev.com/slack/install">
  A friendly AI sfotware engineer for your code chores
</Card>

Click on the `Add To Slack` button. Before enabling Fume in your workspace, make sure you are setting it up for the correct workspace.

<img />

A successful installation will redirect you to Fume's Home page. If you the welcome message below. navigate to the `Messages` tab.

<img />

### Logging In With Slack

As you naviage to the `Messages` tab, you will be able to type messages and slash commands for Fume app. The first thing you must do is logging in. For that, type in the following command.

`/fume-login {your_email} {your_password}`

Note that the curly brackets are only for placeholders. Your command call must be your email and password with a single space in between.

If the login attempt is successful, you will be prompted with a success message like the one below.

<img />

After you have completed all of these steps succesfully, you should be done with setting Fume for your Slack workspace! Go to one of you *PUBLIC CHANNELS* and ask a question with Fume tagged in the end. Everything after that is the same flow that you know and love with the web app.

Note that Fume, for now, only supports Slack public channels. If you want to use Fume in a private channel or a DM, you will have to contact us at [contact@fumedev.com](mailto:contact@fumedev.com).