Skip to content

[Docs]: Quick-start examples missing required auth setup #468

@bcdady

Description

@bcdady

Issue Summary

The quick-start examples in both the main README and packages/server/README.md show:

npx @neuralnomads/codenomad --launch

Running this without a password immediately crashes with:

[ERROR] [app] CLI server crashed err=Error: No server password configured.
Create /home/<user>/.config/codenomad/auth.json or start with --password / CODENOMAD_SERVER_PASSWORD.

Suggestions

  1. Update quick-start examples to include --password or mention that auth setup is required before first run.
  2. Document the auth.json file format. The error message tells users to create ~/.config/codenomad/auth.json, but neither README describes its expected schema.

Environment

  • OS: Ubuntu 24.04 (Linux)
  • Node: v22 via mise
  • Ran via: npx @neuralnomads/codenomad

Co-Authored-By: Oz oz-agent@warp.dev

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions