Skip to content

Commit d750f18

Browse files
add CLI instructions for creating Acode plugins (#16)
* feat: add CLI instructions for creating Acode plugins * Update create-plugin.md --------- Co-authored-by: Raunak Raj <71929976+bajrangCoder@users.noreply.github.com>
1 parent de22a6a commit d750f18

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

docs/getting-started/create-plugin.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,35 @@ It's more convenient to manage this from the sidebar. When you install a local p
129129
This makes plugin development a much smoother experience—previously, it was quite frustrating, but this feature was recently added to improve the workflow.
130130
:::
131131
132+
## Creating Plugins with the CLI<Badge type="warning" text="community" />
133+
134+
You can also quickly scaffold new Acode plugins using the [Acode Plugin CLI](https://github.com/itsvks19/acode-plugin-cli). This tool provides an interactive wizard to generate a plugin project from the official JavaScript or TypeScript templates.
135+
136+
### Installation
137+
138+
If you have Rust installed, you can install the CLI with:
139+
140+
```bash
141+
cargo install acode-plugin-cli
142+
```
143+
144+
### Usage
145+
146+
Run the CLI in your terminal:
147+
148+
```bash
149+
acode-plugin-cli
150+
```
151+
152+
The wizard will guide you to:
153+
154+
- Choose plugin name, ID, version, and description
155+
- Enter author information
156+
- Pick license and keywords
157+
- Select JavaScript or TypeScript template
158+
159+
After completion, your plugin folder will be ready to use.
160+
132161
## Building and Publishing
133162
134163
To share your plugin with the Acode community, follow these steps:
@@ -165,8 +194,6 @@ To share your plugin with the Acode community, follow these steps:
165194

166195
- Checkout a small tutorial of 👉 [How to create Acode Plugins?](https://youtu.be/ls--txHX3RQ?si=ZSvJMsb1KFeQA8zd)
167196

168-
- Tutorial for creating plugin using `acode-cli`: [Here](https://youtube.com/shorts/Uyy2dcLx6iI?si=8M-HorDu0YTPJP-J)
169-
170197
## Customization
171198

172199
Certainly! You have the flexibility to either utilize your own template or start your plugin from scratch. Additionally, you're free to employ alternative bundlers and tools. We'll delve deeper into these customization possibilities in subsequent sections.

0 commit comments

Comments
 (0)