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

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.