Startsida Utforska Hjälp
Registrera dig Logga in
root
/
HeyPuter
spegling av https://github.com/HeyPuter/puter.git
1
0
Fork 0
Filer Ärenden 0 Wiki
Träd: 4a0e4d51b5
Grenar Taggar
HeyPuter
/
tools
KernelDeimos 9aeecb650a doc: generate and edit comments for tools 5 månader sedan
..
comment-parser 9aeecb650a doc: generate and edit comments for tools 5 månader sedan
comment-writer 614f065e17 tweak: disable 4o-mini and mistral in comment writer 6 månader sedan
file-walker 6728dd2571 dev(license-headers): fix excludes list 10 månader sedan
keygen cea29645fe feat: add message encryption between Puter peers 9 månader sedan
license-headers 9aeecb650a doc: generate and edit comments for tools 5 månader sedan
migrations-test 02504690cf test: add database migration tests 10 månader sedan
module-docgen 9aeecb650a doc: generate and edit comments for tools 5 månader sedan
token-count-accuracy 3ed1453939 tool: token count testing 6 månader sedan
.commit eebf379205 Move `.commit` to `/tools` 10 månader sedan
README.md 2c24fe5532 doc: document tools directory (README.md) 5 månader sedan
build_relay.sh e3431cd7f5 dev: add build script for relay 8 månader sedan
build_v86.sh ed0a83ca9d dev: update v86, switch twisp to epoxy-server with twisp feature 7 månader sedan
check-translations.js 9aeecb650a doc: generate and edit comments for tools 5 månader sedan
gen-release-notes.js 9aeecb650a doc: generate and edit comments for tools 5 månader sedan
l_checker_config.json 3a7221dba5 chore: cleanup root directory 10 månader sedan
run-selfhosted.js 10f6e5458e refactor: move WebServerService and socketio to module 6 månader sedan

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.