Getting Started

Getting Started

Upon successful registration, we create an initial Workspace for each user. This collaborative environment allows you, your team members, and Clacky AI to work together seamlessly. Within this workspace, you can create projects and collaborate with Clacky’s AI virtual software engineer, to address real issues in your projects.

Create Project

To create a project, simply connect to an existing repository:

workspace

Currently, we only support connecting to GitHub and GitLab repositories. Support for BitBucket is in the pipeline, so stay tuned for these upcoming features.

Configure Dev Environment

Before creating threads and collaborating with Clacky on specific project issues, we need to set up the development environment for your project. This process is similar to configuring a local development environment, but with Clacky, it’s much simpler. Just follow the prompts and click confirm - Clacky will autonomously handle the configuration work.

Clacky presently provides pre-configuration and support for development environments using the following technology stacks:

  • Node.js (Next.js, Vue, React, Angular, Express, Static(HTML/CSS/JS))
  • Golang (Gin)
  • Python (Django, Flask, Fastapi)
  • Ruby (Rails)
  • Java (Spring Boot)

At present, we do not support projects using other technology stacks. Please avoid importing, creating, or initializing projects that use unsupported technologies at this time. For more details, please refer to the Environment documentation.


Once Clacky completes the setup, you’ll need to submit these initial configuration changes as a Pull Request to your Git platform and merge them into your project’s default branch. This crucial step ensures that the initialization settings are properly applied to all future development threads.

Commit Changes


Click the “Commit Changes” button above the ChatBox to request Clacky to commit and push changes to your Git Platform remote repository. Clacky will review the changes and generate a commit message, then push it after your confirmation.

Create Pull Request

Similarly, by clicking the button above the ChatBox, you can request Clacky to create a PR. Clacky will review the changes and generate a PR description, which you can modify and confirm before submitting to the Git Platform.

Close Root Thread

Once the changes are successfully merged, the root thread will automatically close.

Congratulations! Your project environment is now fully configured and ready for development. You can start creating new development threads to collaborate on your project!

Create New Thread

Starting a new development thread is simple. Begin by having a conversation with Clacky - you can directly input your requirements in the chat box at the bottom of the project page:


Or type ’#’ to bring up a list of GitHub issues from your repository, search and select one to send to Clacky:


Clacky will automatically identify the task requirements and generate a specification based on your discussion. Once you are satisfied with the details, click the button to start a new development thread.

project

In the new development thread, you can work with Clacky to write code and solve problems.

We have developed a robust AI Agent work model that can perform in-depth analysis and indexing of project code repositories. Coupled with a mature workflow, this significantly enhances the quality of the “first” work output.

Additionally, we provide a comprehensive human intervention solution, allowing for feedback and guidance during Clacky’s operation, and enabling direct modifications to the code for adjustments (without switching to a local environment) using Clacky’s Chat, Command K, and other assistant features.

Lastly, with the Git Agent, you can submit your changes and create a pull request.