Install Node.js 26 or a newer version. Create an OpenAI API token.
Install CodeScope as a global command.
npm install -g @eliware/codescope
Check the installed version.
codescope --version
CI tests Ubuntu Linux only. CodeScope accepts Windows, macOS, and FreeBSD paths. The CI workflow does not test these platforms.
Set OPENAI_API_TOKEN in the process environment.
PowerShell:
$env:OPENAI_API_TOKEN = "your-token"Linux shell:
export OPENAI_API_TOKEN="your-token"CodeScope uses a nonblank process value first.
If that value is blank or missing, CodeScope reads ~/.codescope.
On Windows, this path is %USERPROFILE%\.codescope.
The token file must contain this line:
OPENAI_API_TOKEN=your-token
Keep the token outside the repository. Read the configuration guide for token file rules.
Run CodeScope from the repository root. CodeScope uses the current directory as its root.
cd path/to/repository
codescope all
CodeScope sends selected repository content to OpenAI. It prints the provider response to standard output. It does not change repository files or run repository tests.
Use an inspection profile to check for issues.
Use a suggestion profile to get improvement ideas.
Use refactor to get refactoring advice.
Use conventions to find differences from applicable Eliware Test conventions.
Use prompt to send a custom request.
codescope review security
codescope suggest architecture
codescope refactor
codescope conventions
codescope prompt "List the main reliability risks"
Read the command guide for profiles and options.