Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Docs: document every `orchestrai` CLI command in docs/CLI.md

Open
  • Is something wrong?
#48 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
electron, javascript, node.js
Domain
cli, developer-experience, documentation

Research direction

Read the command dispatch in bin/orchestrai.js and bridge behavior in src/services/bridge.js, then check the README for where to add the link. Start the app and run orchestrai --help to identify every command; verify examples against the live app as the acceptance criteria require. Done when docs/CLI.md covers each command, explains the bridge, and is linked from the README.

Written by the indexing model from the issue text.

Description

area:agents documentation good first issue help wanted

Context
Agents drive the canvas through bin/orchestrai.js (create/connect/close terminals, peers/ask/check, portals, routines...). The only documentation is the skill text installed for agents; people need a human reference.

Proposed scope

  • Read the command dispatch in bin/orchestrai.js and src/services/bridge.js; write docs/CLI.md with one section per command: synopsis, options, example, exit codes and typical output.
  • Add a short "How the bridge works" intro (local HTTP bridge started by the app, which terminals can reach it).
  • Link from the README.

Acceptance criteria

  • Every command printed by orchestrai --help appears in the doc.
  • Examples were run against a live app (say so in the PR).

How to get started

  1. Read CONTRIBUTING.md, run npm install && npm start.
  2. Comment here so nobody duplicates the work; ask questions in the thread, we are happy to point you at the right file.
  3. Open a PR that references this issue. Run npm test (or npm run test:unit) first.
Dominant language
JavaScript
Stars
0
Forks
0
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from adaumsilva/OrchestrAI

All issues in adaumsilva/OrchestrAI

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.