Skip to content

docs: add Quick Start section to README for better onboarding #1116

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.

Sign up for GitHub

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

Draft
codegen-sh wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft

docs: add Quick Start section to README for better onboarding #1116

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
928ef0a
docs: add Quick Start section to README for better onboarding
codegen-sh[bot] May 30, 2025
91fd091
Automated pre-commit update
codegen-sh[bot] May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,27 @@

The Codegen SDK provides a programmatic interface to code agents provided by [Codegen](https://codegen.com).

## Quick Start

1. **Install the SDK**:

```bash
pip install codegen
```

1. **Get your API credentials** at [codegen.com/developer](https://codegen.com/developer)

1. **Run your first agent**:

```python
from codegen.agents.agent import Agent

agent = Agent(org_id="YOUR_ORG_ID", token="YOUR_API_TOKEN")
task = agent.run(prompt="Add a hello world function to my codebase")
```

## Example Usage

```python
from codegen.agents.agent import Agent

Expand Down
Loading