You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
api_secret_docs_message="For more information, refer to the documentation at [https://docs.codeflash.ai/getting-started/codeflash-github-actions#add-your-api-key-to-your-repository-secrets]."# noqa
79
+
api_secret_docs_message="For more information, refer to the documentation at [https://docs.codeflash.ai/optimizing-with-codeflash/codeflash-github-actions#manual-setup]."# noqa
80
80
ifnotapi_key:
81
81
msg= (
82
82
"I didn't find a Codeflash API key in your environment.\nYou can generate one at "
Copy file name to clipboardExpand all lines: docs/getting-started/local-installation.mdx
+23-18Lines changed: 23 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,20 +55,6 @@ poetry add codeflash@latest --group dev
55
55
</Tip>
56
56
</Step>
57
57
58
-
<Steptitle="Generate a Codeflash API Key">
59
-
Codeflash uses cloud-hosted AI models and integrations with GitHub. You'll need an API key to authorize your access.
60
-
61
-
1. Visit the [Codeflash Web App](https://app.codeflash.ai/)
62
-
2. Sign up with your GitHub account (free)
63
-
3. Navigate to the [API Key](https://app.codeflash.ai/app/apikeys) page to generate your API key
64
-
65
-
<Note>
66
-
**Free Tier Available**
67
-
68
-
Codeflash offers a **free tier** with a limited number of optimizations. Perfect for trying it out on small projects!
69
-
</Note>
70
-
</Step>
71
-
72
58
<Steptitle="Run Automatic Configuration">
73
59
Navigate to your project's root directory (where your `pyproject.toml` file is or should be) and run:
74
60
@@ -95,13 +81,25 @@ When running `codeflash init`, you will see the following prompts:
95
81
5. Which test framework do you use? (pytest/unittest)
96
82
6. Install GitHub actions for Continuous optimization?
97
83
```
84
+
85
+
After you have answered these questions, the Codeflash configuration will be saved in the `pyproject.toml` file.
98
86
</Step>
99
-
</Steps>
100
87
101
-
After you have answered these questions, the Codeflash configuration will be saved in the `pyproject.toml` file.
102
-
To understand the configuration options, and set more advanced options, see the [Manual Configuration](/configuration) page.
88
+
<Steptitle="Generate a Codeflash API Key">
89
+
Codeflash uses cloud-hosted AI models and integrations with GitHub. If you haven't created one already, you'll need to create an API key to authorize your access.
103
90
104
-
### Step 4: Install the Codeflash GitHub App
91
+
1. Visit the [Codeflash Web App](https://app.codeflash.ai/)
92
+
2. Sign up with your GitHub account (free)
93
+
3. Navigate to the [API Key](https://app.codeflash.ai/app/apikeys) page to generate your API key
94
+
95
+
<Note>
96
+
**Free Tier Available**
97
+
98
+
Codeflash offers a **free tier** with a limited number of optimizations. Perfect for trying it out on small projects!
99
+
</Note>
100
+
</Step>
101
+
102
+
<Steptitle="Install the Codeflash GitHub App">
105
103
106
104
{/* TODO: Justify to users Why we need the user to install Github App even in local Installation or local optimization? */}
107
105
Finally, if you have not done so already, Codeflash will ask you to install the GitHub App in your repository.
@@ -110,6 +108,13 @@ The Codeflash GitHub App allows access to your repository to the codeflash-ai bo
110
108
Please [install the Codeflash GitHub
111
109
app](https://github.com/apps/codeflash-ai/installations/select_target) by choosing the repository you want to install
112
110
Codeflash on.
111
+
</Step>
112
+
113
+
114
+
</Steps>
115
+
116
+
To understand the configuration options, and set more advanced options, see the [Manual Configuration](/configuration) page.
0 commit comments