Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

134 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🐧 Linux Pedia API

Turning the Linux ecosystem into a structured and accessible API


📌 About the Project

Linux Pedia API is an experimental RESTful API designed to provide structured and programmatic access to Linux-related information.

It centralizes data about:

  • 🐧 Linux distributions
  • 🖥️ Commands and usage examples
  • 🧩 Kernel versions
  • 📦 Popular packages
  • 📜 History and technical curiosities

The goal is to make Linux knowledge easier to integrate into applications, bots, dashboards, and educational tools.


🌐 Live Website

Official documentation website:

👉 https://linuxpediaapi.com/


🚀 Technologies Used

Technology Logo Description
Node.js
Node.js
Backend runtime powering the RESTful API endpoints
MongoDB
MongoDB
NoSQL database used to store structured information
HTML, CSS, JS HTML CSS JavaScript Documentation website frontend
Insomnia
Insomnia
API endpoint testing and validation
Vercel
Vercel
Deployment and hosting platform

📁 Project Structure

LinuxPediaAPI/
├── LICENSE
├── api/
│   └── index.js
├── package-lock.json
├── package.json
├── public/
│   ├── about.html
│   ├── documention.html
│   ├── favicon.png
│   ├── images/
│   │   ├── Wallpaper.jpg
│   │   ├── cmds/
│   │   │   ├── cat.svg
│   │   │   ├── cd.svg
│   │   │   ├── chmod.svg
│   │   │   ├── chown.svg
│   │   │   ├── cp.svg
│   │   │   ├── df.svg
│   │   │   ├── find.svg
│   │   │   ├── grep.svg
│   │   │   ├── kill.svg
│   │   │   ├── ls.svg
│   │   │   ├── mkdir.svg
│   │   │   ├── mv.svg
│   │   │   ├── ps.svg
│   │   │   ├── pwd.svg
│   │   │   ├── rm.svg
│   │   │   ├── top.svg
│   │   │   └── touch.svg
│   │   ├── dux1.png
│   │   ├── dux2.png
│   │   ├── dux3.png
│   │   └── ondas.svg
│   ├── index.html
│   ├── robots.txt
│   ├── sitemap.xml
│   ├── style.css
│   └── termsofuse.html
├── readme.md
└── vercel.json

🚀 Running Locally

  1. Clone the repository:
git clone https://github.com/vn-wiki/LinuxPedia.git
cd LinuxPedia
  1. Install dependencies:
npm install
  1. Start the server:
npm start

The API should now be running locally.


📡 Example Endpoint

Example request

GET /api/v1/comandos/arquivos

Example response

[
  { 
    "comandos": "ls",
    "descricao": "Lista arquivos e diretórios",
    "exemplo": "ls -la"
  },
  { 
    "comandos": "cp",
    "descricao": "Copia arquivos ou diretórios",
    "exemplo": "cp arquivo.txt /tmp"
  }
]

📌 Endpoint Pattern

All command endpoints follow this structure:

GET /api/v1/comandos/{categoria}

Replace {categoria} with one of the available categories:

  • arquivos
  • processos
  • rede
  • usuarios
  • pacotes

🤝 Contributing

This is an open community project. Contributions are welcome.

  1. Fork the repository
  2. Create a new branch
  3. Commit your changes
  4. Push to your branch
  5. Open a Pull Request

⚠️ Terms of Use

Linux Pedia API is an open initiative. Please use it responsibly.

Do not:

  • Send mass automated requests
  • Crawl all endpoints repeatedly
  • Use the API for malicious activities or spam

For high-volume usage, please get in contact.


👥 Contributors


👨‍💻 Authors

  • @vito-ysl
  • @Rezys07
  • @alex518123

📜 License

This project is licensed under the MIT License.


✨ Built with care for the Linux community.

About

LinuxPedia é uma API RESTful que reúne comandos e informações essenciais sobre Linux, organizados por categorias como arquivos, pacotes, redes, permissões e scripts. Ideal para consultas rápidas e aprendizado prático para todos os níveis.

Topics

Resources

Stars

Watchers

Forks

Contributors

Languages