KernelDeimos 4647e2d9c0 dev: add experimental firebase authentication 2 minggu lalu
..
ai-responses bcdec32ba2 doc: log some AI responses 3 bulan lalu
api-tester 202e7f06e2 test: cleanup and tweak batch test 4 bulan lalu
comment-parser 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
comment-writer 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
file-walker 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
genwiki eda376b6cc doc: make first sidebar items make sense 2 bulan lalu
keygen 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
license-headers 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
migrations-test 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
module-docgen 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
token-count-accuracy 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
.commit eebf379205 Move `.commit` to `/tools` 10 bulan lalu
README.md 2c24fe5532 doc: document tools directory (README.md) 5 bulan lalu
build_relay.sh e3431cd7f5 dev: add build script for relay 8 bulan lalu
build_v86.sh ed0a83ca9d dev: update v86, switch twisp to epoxy-server with twisp feature 7 bulan lalu
check-translations.js 6a184d52b4 Update copyright notice dates in license headers 4 bulan lalu
doc_helper.js 782e858b3c Update (and automate) events docs (#1164) 2 bulan lalu
gen-release-notes.js 29834f02c0 release: 2.5.1 3 bulan lalu
l_checker_config.json 3a7221dba5 chore: cleanup root directory 10 bulan lalu
run-selfhosted.js 4647e2d9c0 dev: add experimental firebase authentication 2 minggu lalu

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.