anomalyco/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-07-22 18:25:32 -04:00
Code Issues 5.9k Packages Projects Releases 19 Wiki Activity

Getting Started Docs suggestion #537

New Issue
Closed
opened 2026-02-16 17:27:13 -05:00 by yindo · 2 comments
yindo commented 2026-02-16 17:27:13 -05:00
Owner
Copy Link
Copy Source

Originally created by @sethgeoghegan on GitHub (Jul 7, 2025).

Originally assigned to: @jayair on GitHub.

Installing and configuring Opencode was a breeze, but I was a little lost on how to realize the value. Adding some guidance to the project README would have helped me, and might help others get up-to-speed more quickly.

Here's a sample snippet that would have helped me:

Usage

Getting Started

  1. Navigate to your project's root directory:

    cd /path/to/your/project

  2. Start opencode:

    opencode

  3. Initialize your project (recommended):

    /init

    This creates an AGENTS.md file that helps opencode understand your project structure and coding conventions.

Example Workflow

  1. Ask questions about your codebase:

    How does the authentication system work?

  2. Request code changes:

    Add input validation to the user registration form

  3. Get help with debugging:

    Why am I getting this error: TypeError: Cannot read property 'id' of undefined

  4. Generate new features:

    Create a dark mode toggle component

Advanced Usage

  • Run a one-off command:

    opencode run "Fix the type error in src/components/Button.tsx"

  • Use with specific project path:

    opencode /path/to/project
Originally created by @sethgeoghegan on GitHub (Jul 7, 2025). Originally assigned to: @jayair on GitHub. Installing and configuring Opencode was a breeze, but I was a little lost on how to realize the value. Adding some guidance to the project README would have helped me, and might help others get up-to-speed more quickly. Here's a sample snippet that would have helped me: ### Usage #### Getting Started 1. Navigate to your project's root directory: ```bash cd /path/to/your/project ``` 2. Start opencode: ```bash opencode ``` 3. Initialize your project (recommended): ``` /init ``` This creates an `AGENTS.md` file that helps opencode understand your project structure and coding conventions. #### Example Workflow 1. **Ask questions about your codebase**: ``` How does the authentication system work? ``` 2. **Request code changes**: ``` Add input validation to the user registration form ``` 3. **Get help with debugging**: ``` Why am I getting this error: TypeError: Cannot read property 'id' of undefined ``` 4. **Generate new features**: ``` Create a dark mode toggle component ``` #### Advanced Usage - **Run a one-off command**: ```bash opencode run "Fix the type error in src/components/Button.tsx" ``` - **Use with specific project path**: ```bash opencode /path/to/project ```
yindo closed this issue 2026-02-16 17:27:13 -05:00
yindo commented 2026-02-16 17:27:13 -05:00
Author
Owner
Copy Link
Copy Source

@wienans commented on GitHub (Jul 7, 2025):

I see the point of a short / clean Readme. If not in the Readme the docs might be a good place as getting started

@wienans commented on GitHub (Jul 7, 2025): I see the point of a short / clean Readme. If not in the Readme the docs might be a good place as getting started
yindo commented 2026-02-16 17:27:13 -05:00
Author
Owner
Copy Link
Copy Source

@jayair commented on GitHub (Jul 11, 2025):

Thanks Seth I'll take a look.

@jayair commented on GitHub (Jul 11, 2025): Thanks Seth I'll take a look.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
acp
bad
bug
discussion
docs
documentation
enhancement
extension
good first issue
growth
help-wanted
mcp
model-problem
needs:compliance
nix
opentui
perf
pull-request
Mirrored from GitHub Pull Request
 tui
web
windows
zen
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#537
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?