Skip to content

Clarify project initialization commands in README #125

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

Open
jayenashar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify project initialization commands in README #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Codev is an operating system for structured human-AI collaboration. You write sp
npm install -g @cluesmith/codev

# 2. Initialize a project
mkdir my-project && cd my-project
codev init
codev init # for new projects
Copy link
Contributor

@waleedkadous waleedkadous Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can give clearer instructions here:

codev init <dir_name>

or

cd <dir>
codev adopt

Copy link
Author

@jayenashar jayenashar Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

codev init prompts me for the directory to create

if you're willing to change the cli, codev init [dir-name] can work for all use cases:

  • no dir-name specified - prompts user (as now)
  • dir-name specified and does not exist - creates folder (as now)
  • dir-name specified, exists, is empty - sets up folder
  • dir-name specified, exists, is not empty - sets up folder (change from now which refuses. adopt can be an alias for init .)

P.S. imho dir-name should be in square brackets to indicate optionality.

codev adopt # for existing projects

# 3. Verify setup
codev doctor
Expand Down