202e7f06e2
One of the test cases has been rendered redundant so it has been removed. Another test was changed to overwrite a file as it's expected to already exist. |
||
|---|---|---|
| .. | ||
| api-tester | ||
| comment-parser | ||
| comment-writer | ||
| file-walker | ||
| keygen | ||
| license-headers | ||
| migrations-test | ||
| module-docgen | ||
| token-count-accuracy | ||
| .commit | ||
| build_relay.sh | ||
| build_v86.sh | ||
| check-translations.js | ||
| gen-release-notes.js | ||
| l_checker_config.json | ||
| README.md | ||
| run-selfhosted.js | ||
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:
cdinto thetools/comment-writerdirectory- Edit
config.jsonand replaceauth_tokenwith 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.