Introducing Ducky CLI for Vtuber Wiki - Your Friendly Interface to Vtuber Knowledge

[yamiOnEstrogen]

Table of Contents

• What is Ducky?
  • 1. Human-Readable Syntax
  • 2. Access to the API
    • 2.1. List Available API Resources
    • 2.2. Retrieve Specific API Data
  • 3. Get the Source Code
    • 3.1. List Available Repositories
    • 3.2. Clone a Repository
  • 4. Edit Wiki Pages
• Join Us on GitHub
• Images

Hello, Vtuber Wiki community! We are thrilled to announce the upcoming release of "Ducky," our command-line interface (CLI) designed to enhance your interaction with the Vtuber Wiki. Ducky empowers you with straightforward commands to access the API, access our source code, and edit wiki pages with ease. Unlike traditional CLI tools, Ducky is designed to be human-readable, with a user-friendly syntax and clear error messages.

What is Ducky?

Ducky is an open-source project developed by the Vtuber Wiki community, just like the main wiki page. It's your gateway to streamline interactions with the Vtuber Wiki and make your contributions even more accessible. Here are some key features that set Ducky apart:

1. Human-Readable Syntax

No more cryptic commands! Ducky CLI comes with an intuitive and straightforward syntax that makes it easy for users of all levels to understand and use. For example, rather than a complex command like this:

user@machine ~ % cli -fGH 123

With Ducky, you can simply use:

user@machine ~ % ducky /clone vtuberswiki/wiki folder=PATH_TO_FOLDER flags=recursive,output_to_log

2. Access to the API

Ducky provides convenient commands to access the Vtuber Wiki API. Retrieve the information you need with ease. Here are some examples of how you can use Ducky to interact with the API:

List Available API Resources

To see the available API resources, you can use the following command:

user@machine ~ % ducky /api

This will display a list of available API resources, such as authors.json, changelog.json, faq.json, and more.

Retrieve Specific API Data

To retrieve specific data from the API, specify the resource you want to access. For example, to get data from the faq.json resource, you can use the following command:

user@machine ~ % ducky /api faq.json

Ducky will fetch the data and save it to a location on your system, such as:

[OK] Got Data. Saving it to: 'C:\Users\USERNAME\AppData\Roaming\VtuberWiki\api\11-1-2023\faq.json'
[OK] Saved it to: 'C:\Users\USERNAME\AppData\Roaming\VtuberWiki\api\11-1-2023\faq.json'

Feel free to explore the API using Ducky and retrieve the information you need for your Vtuber Wiki interactions.

3. Get the Source Code

With Ducky, you can quickly obtain the source code of the Vtuber Wiki and associated projects. Below are examples of how to clone repositories using Ducky:

List Available Repositories

To see the available repositories, you can use the following command:

user@machine ~ % ducky /clone

This command will display a list of repositories available for cloning. You can then choose from the list, such as "vtuberwiki/wiki" or "vtuberwiki/bot."

Clone a Repository

To clone a specific repository, provide the repository name as an argument. For example, to clone the "vtuberwiki/bot" repository, you can use the following command:

user@machine ~ % ducky /clone vtuberwiki/bot

Ducky will prompt you if the repository already exists and whether you want to override it.

[WARN] vtuberwiki/bot exists. Need override!
[WARN] Would you like to override this project? (Y/n)
> Y
[OK] Cloning into 'C:\Users\USERNAME\AppData\Roaming\VtuberWiki\repos\bot' ...
[OK] Created Repo in 'C:\Users\USERNAME\AppData\Roaming\VtuberWiki\repos\bot'
[OK] You can use “/start bot” to start the project.

You can also clone the "vtuberwiki/wiki" repository using a similar command:

user@machine ~ % ducky /clone vtuberwiki/wiki

Ducky will clone the repository and provide information about the location and how to start the project.

[OK] Cloning into 'C:\Users\USERNAME\AppData\Roaming\VtuberWiki\repos\wiki' ...
[OK] Created Repo in 'C:\Users\USERNAME\AppData\Roaming\VtuberWiki\repos\wiki'
[OK] You can use “/start wiki” to start the project.

Use Ducky to access the source code of Vtuber Wiki projects and get started with your contributions or exploration.

4. Edit Wiki Pages

Contributing to the Vtuber Wiki has never been this straightforward. Ducky makes it easy to edit wiki pages directly from the command line.

Join Us on GitHub

We are committed to the principles of open source and community collaboration. The main Vtuber Wiki is hosted on GitHub, and so is Ducky. You can find our project repository at https://github.com/vtuberwiki/wiki. We encourage you to explore, contribute, and be a part of our open-source community.

Feel free to share your thoughts, feedback, and ideas regarding Ducky. Your input is invaluable in shaping the future of this project.

Stay tuned for the official release of Ducky, and get ready to explore the Vtuber Wiki in a more user-friendly and accessible way. If you have any questions or suggestions, please share them in this discussion.

Let's make Vtuber knowledge more accessible together!

Images