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
docs: General Installation Docs Improvement (#703)
# Motivation
<!-- Why is this change necessary? -->
# Content
<!-- Please include a summary of the change -->
# Testing
<!-- How was the change tested? -->
# Please check the following before marking your PR as ready for review
- [ ] I have added tests for my changes
- [ ] I have updated the documentation or added new documentation as
needed
- Linux is supported on x86_64 and aarch64 with glibc 2.34+
15
+
- Windows is not supported
16
+
- Python, Typescript, Javascript and React codebases
17
+
10
18
## Prerequisites
11
19
12
20
We recommend using [uv](https://github.com/astral-sh/uv) for installation. If you haven't installed `uv` yet:
@@ -17,7 +25,7 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
17
25
## Installing Codegen
18
26
19
27
```bash
20
-
uv tool install codegen
28
+
uv tool install codegen --python 3.13
21
29
```
22
30
23
31
@@ -38,7 +46,7 @@ Let's walk through a minimal example of using Codegen in a project:
38
46
```bash
39
47
codegen init
40
48
```
41
-
49
+
42
50
This creates a `.codegen/` directory with:
43
51
```bash
44
52
.codegen/
@@ -70,6 +78,18 @@ Let's walk through a minimal example of using Codegen in a project:
70
78
codegen reset
71
79
```
72
80
81
+
## Troubleshooting
82
+
83
+
Having issues? Here are some common problems and their solutions:
84
+
85
+
-**I'm hitting an UV error related to `[[ packages ]]`**: This means you're likely using an outdated version of UV. Try updating to the latest version with: `uv self update`.
86
+
-**I'm hitting an error about `No module named 'codegen.sdk.extensions.utils'`**: The compiled cython extensions are out of sync. Update them with `uv sync --reinstall-package codegen`.
87
+
-**I'm hitting a `RecursionError: maximum recursion depth exceeded` error while parsing my codebase**: If you are using python 3.12, try upgrading to 3.13. If you are already on 3.13, try upping the recursion limit with `sys.setrecursionlimit(10000)`.
88
+
89
+
<Note>
90
+
For more help, join our [community Slack](/introduction/community) or check the [FAQ](/introduction/faq).
91
+
</Note>
92
+
73
93
## Next Steps
74
94
75
95
<CardGroupcols={2}>
@@ -103,7 +123,3 @@ Let's walk through a minimal example of using Codegen in a project:
103
123
</Card>
104
124
105
125
</CardGroup>
106
-
107
-
<Note>
108
-
For more help, join our [community Slack](/introduction/community) or check the [FAQ](/introduction/faq).
Copy file name to clipboardExpand all lines: docs/introduction/overview.mdx
+22-4Lines changed: 22 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -29,18 +29,36 @@ codebase.commit()
29
29
30
30
31
31
<Note>
32
-
Codegen handles complex refactors while maintaining correctness, enabling a broad set of advanced code manipulation programs.
32
+
Codegen handles complex refactors while maintaining correctness, enabling a broad set of advanced code manipulation programs.
33
33
</Note>
34
34
35
35
<Tip>Codegen works with both Python and Typescript/JSX codebases. Learn more about language support [here](/building-with-codegen/language-support).</Tip>
0 commit comments