Skip to content

Acode-Foundation/acode-plugin-git

 
 

Repository files navigation

Acode Plugin Git SCM

Version License Acode

Professional Git integration for Acode Editor

FeaturesInstallationRequirementsAPIContributing

Git SCM v2 is a complete rewrite that communicates directly with the native Git binary installed on your system, providing full Git compatibility. This plugin executes real Git commands through Acode's Executor API, ensuring 100% Git compatibility. Unlike JavaScript-based solutions (isomorphic-git), this plugin communicates directly with your system Git installation for full compatibility and optimal performance.

Screenshoots

Source Control File Tree Decorations Branch Management Git Command

Requirements

Git must be installed on your system and Acode latest version with Terminal and Executor API support:

apk add git

SSH (Required for GitHub / SSH remotes)

Alpine Linux ships with Dropbear SSH by default, which conflicts with OpenSSH and causes Git authentication issues. This plugin requires OpenSSH for full compatibility.

After installation, generate and configure your SSH keys normally.

Features

See Git support in Acode to learn about the features of this plugin.

Installation

  1. Open Settings
  2. Select Plugins
  3. Search for "Git SCM"
  4. Tap Install
  5. Restart

How It Works

The plugin follows a Shell → Parse → Render workflow. The same architecture as the VS Code Git extension:

Stage Responsibility
Shell Execute Git commands via Acode Executor API
Parse Process stdout/stderr into internal models
Render Display models in UI (resource state, decorations, views)

API

The Git extension exposes an API, reachable by any other plugin.

Git API

Access the Git API in Acode:

  1. Copy src/api/git.d.ts to your plugin's sources;
  2. Include git.d.ts in your plugin's compilation.
  3. Get a hold of the API with the following snippet:
const gitPlugin = acode.require("git");
const gitAPI = gitPlugin.getAPI(1);

// Get repository
const repo = gitAPI.getRepository("/path/to/repositoy");

// repository status
await repo.status();

// Create a branch
await repo.createBranch("feature-branch", true);

// Commit
await repo.commit("Your commit message", { all: true });

// Push to remote
await repo.push("origin", "main");

SCM API

Access the SCM API:

const scm = acode.require("scm");

// Create a source control provider
const sourceControl = scm.createSourceControl("my-scm", "My SCM", "/public");

// Create resource groups
const changes = sourceControl.createResourceGroup("changes", "Changes");

// Add resources
changes.resourceStates = [
  {
    resourceUri: "/path/to/file",
    decorations: {
      strikeThrough: false,
    },
  },
];

See type definition files:

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Credits & Attribution

This project (the Acode Git SCM integration using Executor) is licensed under the MIT License. See the LICENSE file.

Parts of this project are derived from or heavily inspired by the Visual Studio Code project and its Git extension:

The execution layer has been reworked to use Acode Executor API rather than VS Code's internal APIs.

Support & Contact


Happy coding ✨

About

Plugin for Acode to provide version control features

Resources

License

Stars

2 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 97.7%
  • SCSS 1.8%
  • JavaScript 0.5%