صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
root
/
HeyPuter
mirrorاز https://github.com/HeyPuter/puter.git
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
شاخه: main
شاخه‌ها تگ‌ها
HeyPuter
/
tools
KernelDeimos 4647e2d9c0 dev: add experimental firebase authentication 2 هفته پیش
..
ai-responses bcdec32ba2 doc: log some AI responses 3 ماه پیش
api-tester 202e7f06e2 test: cleanup and tweak batch test 4 ماه پیش
comment-parser 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
comment-writer 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
file-walker 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
genwiki eda376b6cc doc: make first sidebar items make sense 2 ماه پیش
keygen 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
license-headers 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
migrations-test 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
module-docgen 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
token-count-accuracy 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
.commit eebf379205 Move `.commit` to `/tools` 10 ماه پیش
README.md 2c24fe5532 doc: document tools directory (README.md) 5 ماه پیش
build_relay.sh e3431cd7f5 dev: add build script for relay 8 ماه پیش
build_v86.sh ed0a83ca9d dev: update v86, switch twisp to epoxy-server with twisp feature 7 ماه پیش
check-translations.js 6a184d52b4 Update copyright notice dates in license headers 4 ماه پیش
doc_helper.js 782e858b3c Update (and automate) events docs (#1164) 2 ماه پیش
gen-release-notes.js 29834f02c0 release: 2.5.1 3 ماه پیش
l_checker_config.json 3a7221dba5 chore: cleanup root directory 10 ماه پیش
run-selfhosted.js 4647e2d9c0 dev: add experimental firebase authentication 2 هفته پیش

README.md

Tools Directory

This directory contains tools for developing and running puter. Each directory inside /tools is an npm workspace, so it can have its own package.json file and dependencies.

Scripts

run-selfhosted.js

This is the main script for running a local instance of Puter. It verifies the version of node.js you are running and attempts to explain any errors that come up if initiating boot fails.

Puter is booted with essential modules, and modules required for local file storage.

gen-release-notes.js

Generates release notes between a hard-coded pair of versions. These versions need to be modified manually in the script source before running.

check-translations.js

Checks for missing translations in src/gui/src/i18n/translations

Utilities

comment-writer

Generates comments in source files using generative AI via Puter's AI drivers.

To use this:

  • cd into the tools/comment-writer directory
  • Edit config.json and replace auth_token with your own
  • Run with a specified direcotry; for example: node main.js ../../src/backend/services

module-docgen

Document a module.

Libraries

comment-parser

This is a package used by the license-headers tool to process existing comments.

file-walker

This is used by license-headers and comment-writer to walk through source files.