The EVerest Helper Extension is a Visual Studio Code extension designed to automate the setup and management of the EVerest development environment. It simplifies the process of setting up EVerest, managing SSH keys, installing necessary dependencies, and more.
Features
Setup EVerest: Automatically checks and installs the necessary tools, dependencies, and environment settings to get you started with EVerest.
Manage SSH Keys: Checks if your SSH key is uploaded to GitHub and helps you configure it if not.
Dependency Management: Ensures that essential VS Code extensions like Remote-WSL, Docker, and Python are installed.
Getting Started
Prerequisites
Visual Studio Code installed on your machine.
Basic knowledge of using the terminal and Git.
WSL 2 set up on your machine for a Linux environment in Windows (for Windows users).
Open the project in Visual Studio Code:
```bash
cd everest-helper-extension
code .
```
Install the required npm packages:
```bash
npm install
```
Usage
Setup EVerest:
Open the Command Palette in VS Code (Ctrl + Shift + P).
Run the command Setup EVerest.
The extension will check for required dependencies, ask you to manage SSH keys, and set up the EVerest workspace.
Check SSH Key:
If you run the Setup EVerest command, it will automatically check whether you have an SSH key uploaded to GitHub.
If not, it will guide you through generating and uploading one.
Available Commands
Setup EVerest: Initiates the full setup process for EVerest, including dependency checks, SSH key management, and installation of the EVerest workspace.
Contributing
We welcome contributions from the community! Please read the CONTRIBUTING.md file for more details on how to get involved.
License
This project is licensed under the MIT License - see the LICENSE file for details.