Berryjam CLI Docs

Appearance

On this page

Quick Start ​

Scan with Berryjam CLI - Cloud ​

First, you will need to create a Berryjam account and workspace. After that, please choose a project you would like to scan. For demonstration purposes, we will be scanning an open-source project called Koel. Clone or download it to a convenient location to get started.

sh
git clone https://github.com/koel/koel.git

Now, login with your Berryjam account on your preferred terminal. You will be prompted to input email and password.

sh
npx berryjam-cli@latest login

Then, run the scan command with Berryjam scan on the project root directory:

sh
npx berryjam-cli@latest scan .

The terminal will prompt you to install Berryjam CLI (latest version). After that, the CLI will prompt you to confirm the workspace you wish to scan to. Once the scan is complete, Berryjam CLI will provide your workspace URL to click on.

If you need help or support in any way, please don’t hesitate to chat with us on Discord or email us at [email protected]

Remark:

  • We never collects or upload your code. The scan happens locally using the Berryjam CLI. Only metadata is collected. You have full control over what code Berryjam can scan.
  • For open-source Berryjam, please check our Github.
  • If you wish to scan with the latest version, please add @latest after berryjam-cli
  • Here are some other open-source projects you can try: Ant Design Vue and Hackernews