Skip to content

Home

Jump to bottom
Hari Chalise edited this page Nov 22, 2024 · 15 revisions

Carch Wiki

Welcome to the Carch wiki! Carch is a Bash-based Linux project aimed at automating and simplifying the setup process for Arch Linux users. It provides scripts for configuring various system components, such as window managers, package installations, theming, and more. The project features a modern, text-based user interface (TUI) using gum and figlet to create a visually appealing experience during setup.

carchp1

Contents

  1. Getting Started
  2. Features
  3. Installation
  4. Usage
  5. GTK
  6. AUR
  7. Contributing
  8. FAQ
  9. License

Getting Started

Carch is designed to make setting up Arch Linux easier by automating common tasks. Before starting, ensure that you are using Arch Linux or an Arch-based distribution. Carch includes a variety of scripts to help you configure your system according to your preferences.

Requirements

  • Arch Linux or an Arch-based distribution
  • Bash
  • gum (for enhanced menu interaction)
  • figlet (for stylized text headers)
  • GTK (Latest Version)
  • python (for GTK)

Features

Automated Arch Setup

  • Simplifies the initial Arch Linux setup by providing scripts for installing essential packages, configuring window managers, and more.

Enhanced Text-Based User Interface

  • Utilizes gum for a smoother, modern TUI experience and figlet for clear, stylized headers in menus.

Hyprland Setup Script

  • Guides you through setting up and configuring Hyprland in a step-by-step manner.

Theming and Icon Setup

  • Installs and configures themes and icons based on the user's environment (X11 or Wayland).

Package Installation

  • Provides categorized scripts for different types of software (communication tools, browsers, editing software, etc.).

Extensible Design

  • Users can easily add or modify scripts to customize their setup.

Installation

To install Carch, run the following command in your terminal:

bash <(curl -L https://chalisehari.com.np/carch)

This command will download and execute the setup script, guiding you through the installation process.

Usage

  1. Launch Carch by typing carch in your terminal:
carch

  1. Main Menu Options:

    • Arch Setup: Access a submenu with various setup options.
    • Help: Displays helpful information in a simple, easy-to-read format.
    • Exit: Exits the application.

  2. Arch Setup Submenu Options:

    • Install Essential Packages: Installs the core packages required for your setup.
    • Hyprland Setup: Guides you through setting up Hyprland, with prompts and progress indicators.
    • Theming and Icon Setup: Installs and configures themes based on your display server environment.
    • Communication Tools: Installs essential communication applications.
    • Browsers: Provides options to install web browsers.
    • Editing Software: Installs various editing tools.
    • Other Utilities: Includes additional utility scripts.

  3. Navigating the TUI:

    • Use the menu powered by gum for smooth navigation.
    • Select options with Enter, and follow on-screen instructions for further steps.

  4. Running Scripts Directly: You can run specific scripts for tasks like package installation or theming directly from the TUI while keeping the main interface open.

GTK

The GTK version of Carch is available.

Caution

The GTK version of Carch is currently under development.
It’s not fully ready for use and needs some script updates to work properly. You may try it now as you would with the usual Carch script.

How to Install and Use 📦

Prerequisites

Simply run the main script:

bash <(curl -L https://chalisehari.com.np/carch)

Once done, you can launch the Carch GTK interface by typing:

carch-gtk

Note: You can also run the Carch GTK interface after installing it from the AUR.

From Source

Before you start, you'll need to install Python dependencies.

On Arch Linux:

sudo pacman -S python

Using AUR (with paru or yay):

paru -S python
# or
yay -S python

Install and Run Carch

Clone the Carch repository and run the GTK script:

git clone https://github.com/harilvfs/carch
cd carch
python3 carch-gtk.py

Note

If any errors pop up while running the script, they are likely related to missing dependencies. Make sure to install all required Python dependencies.

Aur

Packaging status

Carch is also available in the AUR package repository.

Package carch-git

You can install it using an AUR package manager.

Select <packager> then

<packager> -S carch-git

You can also install it using a package build.

git clone https://aur.archlinux.org/carch-git.git
cd carch-git
makepkg -si

Note

To access the latest commit or updates of Carch, you can use the command line instead of the AUR.
The AUR package may take some time to update, so using the command line will ensure you get the latest version.

Contributing

Contributions are welcome! To contribute:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Submit a pull request once your changes are ready for review.

For bug reports or feature suggestions, please open an issue on the GitHub repository. For the contributing guide, check out contributing.md.

FAQ

Q: What is Carch?
A: Carch is a tool designed to simplify and automate the setup process for Arch Linux users. It provides scripts for various tasks, including installing packages and configuring the system.

Q: Can I use Carch on non-Arch Linux distributions?
A: Carch is specifically designed for Arch Linux and Arch-based distributions. Using it on other distributions may cause unexpected behavior.

Q: How do I customize the scripts?
A: You can edit the Bash scripts located in the Carch repository. The modular design allows for easy addition or modification of scripts to meet your specific setup requirements.

License

Carch is licensed under the Apache License 2.0.

Clone this wiki locally