Skip to main content

Scaffolding Engine for Nimble Documentation Organizer Kit: Generator folder dokumentasi proyek yang simpel dan cepat.

Project description

sendok 🥄

sendok (Scaffolding Engine for Nimble Documentation Organizer Kit) is a simple and fast development tool to manage project documentation and speed up your terminal workflow.

🇮🇩 Bahasa Indonesia | 🇪🇸 Español | 🇯🇵 日本語 | 🇨🇳 中文


✨ Key Features

  • 🚀 Instant Documentation: Initialize docs/ folder with standard templates (SSH, Git, Node, NVM, Angular, GitHub CLI).
  • 🌐 Multi-language Support: Templates available in 5 languages (EN, ID, ES, JA, ZH).
  • 🍴 Git Helper (gg): Manage Git interactively! Supports auto-init, staging (unstage/discard), and automatic fix for dubious ownership errors.
  • 🛡️ Backup Manager (bum): Smartly backup your project. Ignores heavy folders (node_modules) while keeping sensitive files (.env).
  • ⚡ Global Shorthands: One-letter commands for common tasks (Reload, Clear screen, IP Info, etc).
  • 🎨 Interactive Interface: User-friendly menu powered by questionary.

🛠️ Installation

From Source (Recommended for Global Shorthands)

  1. Clone this repository.
  2. Enter the project folder.
  3. Run the following command:
pip install -e .

🚀 Usage Guide

1. Interactive Menu

Run the tool with your preferred language to open the navigation menu:

  • sendok en : Menu in English (Default).
  • sendok id : Menu in Indonesian.
  • sendok es : Menu in Spanish.
  • sendok ja : Menu in Japanese.
  • sendok zh : Menu in Chinese.

2. Global Shorthands (Direct in Terminal)

After installation, you can use these commands directly from your terminal:

Command Function
r Refresh terminal & VS Code UI
gg Run Git GUI Helper (Interactive)
c Clear terminal screen (cls or clear)
p Show IP information (ipconfig or ifconfig)
bum Run Backup Manager for the current folder
lll Run npm run build
bum Run Backup Manager for the current folder

3. Git Helper (gg) Features

Use the gg command for easier Git management without memorizing terminal commands:

Menu Action Git Command Equivalent Description
Auto-Init git init Automatically creates a repo if not found.
Staging git add Add files to the commit queue.
Unstage git reset Remove files from the queue (safe).
Discard git restore Discard edits & reset file (be careful!).
Commit git commit Record changes permanently.
Push/Pull git push/pull Sync with server (GitLab/GitHub).
Branch git branch Manage coding branches.
Remove Git rd /s /q .git Restore folder to normal (delete Git).
Auto-Fix git config ... Automatically fix dubious ownership errors.

4. Standard Subcommands

  • sendok init [id|en|es|ja|zh]: Create documentation folder.
  • sendok reload: Refresh terminal and VS Code UI.
  • sendok list: View available documentation templates.
  • sendok clean: Delete docs/ folder.
  • sendok about: Show application developer information.

🛡️ Backup Manager (bum)

The bum feature creates a timestamped backup folder at .bum/[project_folder]-[date]-[time]. This process automatically ignores:

  • node_modules, .git, venv, .venv
  • dist, build, __pycache__
  • The .bum folder itself (to avoid recursion)

👤 Author

🥄 Simple. Fast. Spooning documents like a pro!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sendok-0.1.0.tar.gz (48.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sendok-0.1.0-py3-none-any.whl (64.3 kB view details)

Uploaded Python 3

File details

Details for the file sendok-0.1.0.tar.gz.

File metadata

  • Download URL: sendok-0.1.0.tar.gz
  • Upload date:
  • Size: 48.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for sendok-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7c1d4be026b63a7626d416358de717226a170987eb549eac5a73591cc725deae
MD5 cef6d13d1eadf93edcc3f0c2fab62761
BLAKE2b-256 8fa131719fa890b726c97fd147317d6a1610e520d1a0ca44c4e3e3666bf6cea8

See more details on using hashes here.

File details

Details for the file sendok-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sendok-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 64.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for sendok-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d0ee096223fd00a27569c81876d4d284e667a345997101df60f8dae0446fc02
MD5 870260b29e3866fadc6438f4dc4c3a2d
BLAKE2b-256 da8f1abd6e3ccdcf08bfabd79ff38f2b9b9b6eb9b7af2dcc62d4df8b9aa26858

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page