> ## Documentation Index
> Fetch the complete documentation index at: https://codegeninc-codegen-bot-sdk-docs-2-0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Codebase
> This class provides the main entrypoint for most programs to analyzing and manipulating codebases.
export const Attribute = ({type, description}) => ;
export const GithubLinkNote = ({link}) =>
;
export const HorizontalDivider = ({light = false}) => ;
export const Return = ({return_type, description}) => ;
export const ParameterWrapper = ({children}) => ;
export const Parameter = ({name, type, description, defaultValue}) =>
{defaultValue ?
default:
{defaultValue}
:
required
}
{description}
;
## Attributes
### classes
list[ Class ] } description="List of all Classes in the codebase." />
### codeowners
list[ CodeOwner [ SourceFile ]] } description="List all CodeOnwers in the codebase." />
### current\_commit
GitCommit | None } description="Returns the current Git commit that is checked out in the repository." />
### default\_branch
str } description="The default branch of this repository." />
### directories
list[ Directory ] } description="List all directories in the codebase." />
### exports
list[ TSExport ] } description="Returns a list of all Export nodes in the codebase." />
### external\_modules
list[ ExternalModule ] } description="Returns a list of all external modules in the codebase." />
### functions
list[ Function ] } description="List of all Functions in the codebase." />
### github
RepoOperator } description="Access GitHub operations through the repo operator." />
### global\_vars
list[ Assignment ] } description="List of all GlobalVars in the codebase." />
### imports
list[ Import ] } description="Returns a list of all Import nodes in the codebase." />
### interfaces
list[ TSInterface ] } description="Retrieves all interfaces in the codebase." />
### language
ProgrammingLanguage } description="The programming language of the repository." />
### name
str } description="The name of the repository." />
### repo\_path
Path } description="The path to the repository." />
### symbols
list[ Symbol ] } description="List of all top-level Symbols (Classes, Functions, etc.) in the codebase. Excludes Class" />
### types
list[ TSTypeAlias ] } description="List of all Types in the codebase (Typescript only)." />
## Methods
### ai
Generates a response from the AI based on the provided prompt, target, and context.
str } description="The text prompt to send to the AI." defaultValue="" />
Editable | None } description="An optional editable object (like a function, class, etc.) that provides the main focus for the AI's response." defaultValue="None" />
Editable | list[ Editable ] | dict[str, Editable | list[ Editable ]] | None } description="Additional context to help inform the AI's response." defaultValue="None" />
str } description="The AI model to use for generating the response. Defaults to "gpt-4o"." defaultValue=""gpt-4o"" />
str } description="The generated response from the AI." />
### checkout
Checks out a git branch or commit and syncs the codebase graph to the new state.
str | GitCommit | None } description="Hash or GitCommit object to checkout. Cannot be used with branch." defaultValue="None" />
str | None } description="Name of branch to checkout. Cannot be used with commit." defaultValue="None" />
bool } description="If True, creates the branch if it doesn't exist. Defaults to False." defaultValue="False" />
bool } description="If True, attempts to pull from remote when checking out branch. Defaults to False." defaultValue="False" />
CheckoutResult } description="The result of the checkout operation." />
### commit
Commits all staged changes to the codebase graph and synchronizes the graph with the filesystem if specified.
bool } description="Whether to synchronize the graph after committing changes. Defaults to True." defaultValue="True" />
None } description="" />
### create\_directory
Creates a directory at the specified path.
str } description="The path where the directory should be created." defaultValue="" />
bool } description="If True, don't raise an error if the directory already exists. Defaults to False." defaultValue="False" />
bool } description="If True, create any necessary parent directories. Defaults to False." defaultValue="False" />
None } description="" />
### create\_file
Creates a new file in the codebase with specified content.
str } description="The path where the file should be created." defaultValue="" />
str } description="The content of the file to be created. Defaults to empty string." defaultValue="""" />
bool } description="Whether to sync the graph after creating the file. Defaults to True." defaultValue="True" />
SourceFile } description="The newly created file object." />
### create\_pr
Creates a pull request from the current branch to the repository's default branch.
str } description="The title for the pull request" defaultValue="" />
str } description="The description/body text for the pull request" defaultValue="" />
PullRequest } description="The created GitHub pull request object" />
### create\_pr\_comment
Create a comment on a pull request
None } description="" />
### create\_pr\_review\_comment
Create a review comment on a pull request.
None } description="" />
### files
A list property that returns all files in the codebase.
list[ SourceFile ] | list[ File ] } description="A sorted list of source files in the codebase." />
### find\_by\_span
Finds editable objects that overlap with the given source code span.
Span } description="The span object containing the filepath and byte range to search within." defaultValue="" />
list[ Editable ] } description="A list of Editable objects that overlap with the given span." />
### from\_files
Creates a Codebase instance from multiple files.
Codebase } description="A Codebase instance initialized with the provided files" />
### from\_repo
Fetches a codebase from GitHub and returns a Codebase instance.
str } description="The name of the repository in format "owner/repo"" defaultValue="" />
Optional[str] } description="The directory to clone the repo into. Defaults to /tmp/codegen" defaultValue=""/tmp/codegen"" />
Optional[str] } description="The specific commit hash to clone. Defaults to HEAD" defaultValue="None" />
bool } description="Whether to do a shallow clone. Defaults to True" defaultValue="" />
Literal["python", "typescript"] | ProgrammingLanguage | None } description="The programming language of the repo. Defaults to None." defaultValue="" />
CodebaseConfig } description="Configuration for the codebase. Defaults to pre-defined defaults if None." defaultValue="" />
SecretsConfig } description="Configuration for the secrets. Defaults to empty values if None." defaultValue="" />
Codebase } description="A Codebase instance initialized with the cloned repository" />
### from\_string
Creates a Codebase instance from a string of code.
Codebase } description="A Codebase instance initialized with the provided code Example: >>> # Python code >>> code = "def add(a, b): return a + b" >>> codebase = Codebase.from_string(code, language="python") >>> # TypeScript code >>> code = "function add(a: number, b: number): number { return a + b; }" >>> codebase = Codebase.from_string(code, language="typescript")" />
### get\_class
Returns a class that matches the given name.
str } description="The name of the class to find." defaultValue="" />
bool } description="If True, return None when class is not found instead of raising ValueError. Defaults to False." defaultValue="False" />
Class | None } description="The class with the given name, or None if optional=True and class not found." />
### get\_directory
Returns Directory by `dir_path`, or full path to the directory from codebase root.
str } description="The path to the directory to retrieve." defaultValue="" />
bool } description="If True, return None when directory is not found. If False, raise ValueError." defaultValue="False" />
Directory | None } description="The Directory object if found, None if optional=True and directory not found." />
### get\_file
Retrieves a file from the codebase by its filepath.
str } description="The path to the file, relative to the codebase root." defaultValue="" />
bool } description="If True, return None if file not found. If False, raise ValueError." defaultValue="False" />
bool } description="If True, ignore case when checking for file existence. Defaults to False." defaultValue="False" />
SourceFile | None } description="The source file if found, None if optional=True and file not found." />
### get\_function
Retrieves a function from the codebase by its name.
str } description="The name of the function to retrieve." defaultValue="" />
bool } description="If True, returns None when function is not found instead of raising ValueError." defaultValue="False" />
Function | None } description="The matching function if found. If optional=True and no match is found, returns None." />
### get\_modified\_symbols\_in\_pr
Get all modified symbols in a pull request
tuple[str, dict[str, str], list[str], str] } description="" />
### get\_relative\_path
Calculates a relative path from one file to another, removing the extension from the target file.
str } description="The file path from which the relative path will be computed." defaultValue="" />
str } description="The file path (whose extension will be removed) to which the relative path will be computed." defaultValue="" />
str } description="The relative path from `from_file` to `to_file` (with the extension removed from `to_file`)." />
### get\_symbol
Returns a Symbol by name from the codebase.
str } description="The name of the symbol to find." defaultValue="" />
bool } description="If True, returns None when symbol is not found. If False, raises ValueError. Defaults to False." defaultValue="False" />
Symbol | None } description="The matched Symbol if found, None if not found and optional=True." />
### get\_symbols
Retrieves all symbols in the codebase that match the given symbol name.
str } description="The name of the symbols to retrieve." defaultValue="" />
list[ Symbol ] } description="A list of Symbol objects that match the given name, sorted alphabetically." />
### git\_commit
Stages + commits all changes to the codebase and git.
str } description="The commit message" defaultValue="" />
bool } description="Whether to verify the commit before committing. Defaults to False." defaultValue="False" />
GitCommit | None } description="The commit object if changes were committed, None otherwise." />
### has\_directory
Returns a boolean indicating if a directory exists in the codebase.
str } description="The path to the directory to check for, relative to the codebase root." defaultValue="" />
bool } description="True if the directory exists in the codebase, False otherwise." />
### has\_file
Determines if a file exists in the codebase.
str } description="The filepath to check for existence." defaultValue="" />
bool } description="If True, ignore case when checking for file existence. Defaults to False." defaultValue="False" />
bool } description="True if the file exists in the codebase, False otherwise." />
### has\_symbol
Returns whether a symbol exists in the codebase.
str } description="The name of the symbol to look for." defaultValue="" />
bool } description="True if a symbol with the given name exists in the codebase, False otherwise." />
### reset
Resets the codebase by
None } description="" />
### set\_ai\_key
Sets the OpenAI key for the current Codebase instance.
None } description="" />
### set\_session\_options
Sets the session options for the current codebase.
int, optional } description="The maximum number of transactions" defaultValue="" />
int, optional } description="The maximum duration in seconds for a session" defaultValue="" />
int, optional } description="The maximum number of AI requests" defaultValue="" />
None } description="" />
### should\_fix
Returns True if the flag should be fixed based on the current mode and active group.
CodeFlag } description="The code flag to check." defaultValue="" />
bool } description="True if the flag should be fixed, False if it should be ignored. Returns False in find mode. Returns True if no active group is set. Returns True if the flag's hash exists in the active group hashes." />
### visualize
Visualizes a NetworkX graph or Plotly figure.
Graph | go.Figure } description="A NetworkX graph or Plotly figure to visualize" defaultValue="" />
Editable | str | int | None } description="The root node to visualize around. When specified, the visualization will be centered on this node. Defaults to None." defaultValue="None" />
None } description="" />