Git Product home page Git Product logo

codecursor's Introduction

CodeCursor (Cursor for Visual Studio Code)

Use Cursor right in the editor you love!

First of all, we would like to thank Cursor Team for their brilliant works. Please give their app a try!

What's Cursor? And Why This Extension?

Cursor is an AI code editor based on OpenAI GPT models. You can write, edit, and chat about your code with it. At this time, Cursor is only provided as a dedicated app, and the team currently has no plans to develop extensions for other editors or IDEs.

We believe there are more developers actively using Visual Studio Code as their main tool for serious work. This is why we built CodeCursor. It's not going to replace the Cursor app, but it provides another way to use Cursor.

Getting Started

You must sign into your Cursor account or configure you own API keys to use this extension. Please refer to the Custom API Keys section for details.

๐ŸŒŸ Experimental: Generate entire projects with the AI ๐ŸŒŸ

We bring the experimental features of Cursor's latest AI-generated projects to CodeCursor. Now you can directly create entire projects through AI in VS Code.

When you have opened a workspace, you will be able to see the Generate Project command in the Command Palette.

Project Generation

If the currently opened workspace is not empty, you will receive a warning dialog asking if you want to continue.

Workspace Not Empty Warning

While project generation is in progress, a progress dialog will be displayed. You can click the cancel button on the progress bar at any time to cancel the task.

Code Generation

Just open a document and type CodeCursor in Command Palette. You will see the command below:

Command Palette

Type your prompt and the code generation will just begin. To edit some existing code, you can also select something before performing this command. When accepting the change, the selected code will be replaced with the generated one.

While code generation is in progress, the following status bar item will be displayed:

Generating

Click on it to cancel the request. Upon completion of code generation, the status bar item will change to a "check mark". You can click it to reopen the generated result at any time.

The generated contents will be live streamed, and shown as a text diff. You can simply apply the changes by clicking the "Accept" button in the notification:

Completed

Chat

You can chat with your code just like using ChatGPT. To open the chat panel, click "CodeCursor" icon on the Activity Bar. You can ask questions about the currently opened document or a selected piece of text.

Chat

Custom API Keys

The Cursor server may become unstable when it's under heavy traffic. You can provide your own OpenAI API keys to have a smoother user experience. You can also choose the model you want to use when a key is set. For details, please refer to the extension configuration.

Note:
Your API key will be sent to Cursor server.

Known Issues

  • Due to limitations in the new version of the Cursor API, the automatic continuation ability for long code is currently unavailable.
  • If you trigger Generate Project command multiple times simultaneously, undefined behavior may occur.

To track all issues / file a new issue please go to the GitHub repo.

Security Consideration

The extension DOES NOT collect your code, environment data, or any information that could be used to track you. Additionally, we ensure that the Cursor server will not receive that data either. Only the document you perform code generation against will be uploaded to the Cursor server, and they are responsible for preventing any leaks of your code.

Contributing

To develop the extension, clone the repository and open it in Visual Studio Code. There are two launch targets: "Run Extension" and "Run Extension (Without Rust)". If you only want to debug or work on the UI parts, then you can select "Run Extension (Without Rust)" for faster build speed.

You are welcome to open Pull Requests at any time. But it's still better to start a discussion before making some epic changes.

License

MIT

codecursor's People

Contributors

davidmetcalfe avatar ktiays avatar unixzii avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.