Toolkit

Toolkit is a CLI that helps you to initialize your development environment faster.

Features

🌎 Cross-platform support (macOS, Windows. Linux is coming soon)

✨ Support custom your toolkits and install them with one command

📦 Share your toolkits manifest with your team members

🚀 Built with rust and install toolkits in parallel

Quick Start

Windows Users NOTE: Currently, you may need to follow the installation instructions to install toolkits manually.

Using a script (For MacOS and Linux)

curl -fsSL https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/shell/install.sh | bash -s -- --install

Parameters

--install Install the recommended toolkits (for web development)

--manifest

Install your toolkits by specifying the manifest file path. For example:

curl -fsSL https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/shell/install.sh | bash -s -- --install --manifest https://the-remote-server/your-toolkits-manifest-path

# install the recommended toolkits(for web development)
$ .\toolkit.exe install
# install your custom toolkits by specifying the manifest file path
$ .\toolkit.exe install --manifest <your-manifest-path>

Using a release binary

1. Download the latest release binary for your system
2. Unzip the downloaded file
3. Run the following commands in your terminal

Macos and Linux

$ chmod +x toolkit

# install the default toolkits (for web development)
$ ./toolkit install
# install your toolkits by specifying the manifest file path
$ ./toolkit install --manifest <your-manifest-path>

Windows

# install the default toolkits (for web development)
$ .\toolkit.exe install
# install your toolkits by specifying the manifest file path
$ .\toolkit.exe install --manifest <your-manifest-path>

Customization

You can customize your toolkits which to be installed in a json file. Here is a json schema for you to follow and you can get the hint in the popular IDEs like Visual Studio Code, IntelliJ and so on. For Example:

{
  "$schema": "https://raw.githubusercontent.com/apptools-lab/AppToolkit/feat/cli/toolkits.schema.json",
  "description": "<your toolkits schema description>",
  "author": "<your name or email>",
  "version": "<toolkits manifest version>",
  "toolkits": [
    {
      "name": "Visual Studio Code",
      "description": "<vscode description>",
      "installations": [
        {
            ...
        }
      ]
    }
  ]
}

Now AppToolkit supports the following types of tool:

• Windows
  • exe
• MacOS
  • dmg
  • zip
  • shell
• Linux
  • deb
  • rpm
  • shell

If you want to support more types of toolkits, you can submit a PR or issue to us.

You can see tookits.manifest.json for reference.

After completion, you can save your toolkit schema in a json file locally or upload it to the remote server(GitHub repo or cloud storage). You can share your toolkit manifest with your team members or friends.

Then you can install your custom toolkits with the following command:

# windows
$ .\toolkit.exe install --manifest https://the-remote-server/your-toolkits-manifest-path

# macos
$ ./toolkit install --manifest https://the-remote-server/your-toolkits-manifest-path

Contribution

Toolkit is still in the early stage of development, and we are working hard to improve it. If you have any suggestions or ideas, please feel free to submit an issue or PR.