Skip to content

Commit c874dcb

Browse files
committed
Update docs for specifying directory
1 parent 589fad6 commit c874dcb

File tree

3 files changed

+25
-19
lines changed

3 files changed

+25
-19
lines changed

web/src/content/advanced/large-projects.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ When working with large codebases, you can start Codebuff from specific director
1818
codebuff
1919
```
2020

21+
Or equivalently without changing directories:
22+
23+
```bash
24+
codebuff --cwd backend
25+
```
26+
2127
This helps Codebuff concentrate on relevant files and provide more targeted assistance.
2228

2329
## Knowledge Organization

web/src/content/tips/knowledge-files.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Codebuff uses knowledge files to store project-specific information and best pra
1414
You can ask Codebuff to create an initial knowledge file for your project:
1515

1616
```bash
17-
codebuff . "Please create a knowledge.md file with initial project information"
17+
codebuff "Please create a knowledge.md file with initial project information"
1818
```
1919

2020
Or create one manually:

web/src/content/tips/other-use-cases.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Get feedback on your changes:
1515

1616
```bash
1717
# Review current changes
18-
codebuff <project-path> "Please review my current changes"
18+
codebuff "Please review my current changes"
1919

2020
# Review branch
21-
codebuff <project-path> "Review the differences between this branch and main"
21+
codebuff "Review the differences between this branch and main"
2222

2323
# Review specific files
24-
codebuff <project-path> "Review the changes in src/components/auth/*"
24+
codebuff "Review the changes in src/components/auth/*"
2525
```
2626

2727
## Git Workflow Commands
@@ -30,10 +30,10 @@ Manage your git workflow:
3030

3131
```bash
3232
# Create commit message
33-
codebuff <project-path> "Generate a commit message for these changes"
33+
codebuff "Generate a commit message for these changes"
3434

3535
# Clean up commits
36-
codebuff <project-path> "Help me squash the last 3 commits into one"
36+
codebuff "Help me squash the last 3 commits into one"
3737
```
3838

3939
## Codebase Questions
@@ -42,10 +42,10 @@ Understand your codebase:
4242

4343
```bash
4444
# Architecture questions
45-
codebuff <project-path> "Explain how our authentication system works"
45+
codebuff "Explain how our authentication system works"
4646

4747
# Find examples
48-
codebuff <project-path> "Show me examples of error handling in our codebase"
48+
codebuff "Show me examples of error handling in our codebase"
4949
```
5050

5151
## Script Generation
@@ -54,10 +54,10 @@ Create scripts for common tasks:
5454

5555
```bash
5656
# Data processing
57-
codebuff <project-path> "Write a script to calculate our churn this month"
57+
codebuff "Write a script to calculate our churn this month"
5858

5959
# Build automation
60-
codebuff <project-path> "Create a script to automate our release process"
60+
codebuff "Create a script to automate our release process"
6161
```
6262

6363
## Documentation Commands
@@ -66,13 +66,13 @@ Generate and update documentation:
6666

6767
```bash
6868
# API docs
69-
codebuff <project-path> "Document this new API endpoint"
69+
codebuff "Document this new API endpoint"
7070

7171
# Component docs
72-
codebuff <project-path> "Add JSDoc comments to this React component"
72+
codebuff "Add JSDoc comments to this React component"
7373

7474
# README updates
75-
codebuff <project-path> "Update the README with the new environment variables"
75+
codebuff "Update the README with the new environment variables"
7676
```
7777

7878
## Configuration Commands
@@ -81,10 +81,10 @@ Handle configuration tasks:
8181

8282
```bash
8383
# Tool setup
84-
codebuff <project-path> "Help me configure ESLint for this project"
84+
codebuff "Help me configure ESLint for this project"
8585

8686
# Build config
87-
codebuff <project-path> "Update webpack to handle .mdx files"
87+
codebuff "Update webpack to handle .mdx files"
8888
```
8989

9090
## SQL Commands
@@ -93,16 +93,16 @@ Get help with database operations:
9393

9494
```bash
9595
# Query writing
96-
codebuff <project-path> "Help me write a query to find users who haven't logged in for 30 days"
96+
codebuff "Help me write a query to find users who haven't logged in for 30 days"
9797

9898
# Query optimization
99-
codebuff <project-path> "How can I make this query faster?"
99+
codebuff "How can I make this query faster?"
100100

101101
# Index suggestions
102-
codebuff <project-path> "What indexes should I add for this query?"
102+
codebuff "What indexes should I add for this query?"
103103

104104
# Schema changes
105-
codebuff <project-path> "Help me write a migration to add a status column"
105+
codebuff "Help me write a migration to add a status column"
106106
```
107107

108108
Remember that Codebuff understands natural language, so you don't need to use exact commands. Describe what you want to do in your own words, and Codebuff will help you accomplish it.

0 commit comments

Comments
 (0)