Home Run the test-data engine from a local checkout

Run the test-data engine from a local checkout

Use the command line to write fixtures to files or generate SQL in a development workflow. These instructions use repository source and do not assume an npm release exists.

Source access and license

The source repository is currently private. The checkout instructions below are for authorized collaborators with repository access. The browser tools remain available without source access. The CLI package declares UNLICENSED; no public source-code license or npm publication is implied. See the maintainer profile for the project identity, or use the browser tools.

Source, requirements and license status

The source repository is azmiyuksel/fundata on GitHub. The CLI package declares Node.js 18 or newer and uses the engine files in the repository; this checkout workflow does not need an npm dependency install. Use a currently supported Node.js release for your environment.

The package's license field is UNLICENSED. Publicly readable source is not a grant of an open-source license. Review the repository's current terms and resolve permission questions with the maintainer before adopting or redistributing it. The free browser tool and source licensing are separate subjects.

The maintainer's public contact point is the azmiyuksel GitHub profile. Use repository issues for reproducible bugs when issues are enabled. Do not post credentials, production records or private schemas.

Inspect the checkout and discover the interface

After reviewing the source and applicable terms, obtain a local checkout and run these commands from its root:

git clone https://github.com/azmiyuksel/fundata.git
cd fundata
node cli/bin/fundata.js --help
node cli/bin/fundata.js types
node cli/bin/fundata.js templates
git rev-parse HEAD

Record the revision printed by the last command. Field IDs and their options come from types; template keys come from templates. Commands below use the checkout path rather than npx fundata-cli, so their behavior does not depend on registry publication.

Write a small fixture and inspect it

node cli/bin/fundata.js generate --field id:row_number --field name:full_name --field email:email_address --rows 3 --seed qa-demo-v1 --format json --out users.json

The output file contains three synthetic users. --out writes a file; without it, the result goes to standard output. If the output path contains directories, create those directories first. Add fields with repeated --field name:type arguments; optional settings use --field age:integer:min=18,max=65.

The command line supports CSV, TSV, JSON, NDJSON, SQL and XML, with a row limit of 100,000. XLSX is a browser export, not a CLI format. Use --schema schema.json for a JSON schema file exported by the builder, or a field array with name, type, opts and blank properties. This is the tool's native schema, not an arbitrary JSON Schema document.

Reproduce data without promising permanent bytes

Keep the schema, seed, output format, SQL options and engine revision together. Set fixed date bounds: some built-in templates use the current date as a default upper bound. A seed fixes randomness, but it does not freeze changing schema defaults or source datasets. For long-lived exact fixtures, keep the reviewed generated file.

The --share option reads an embedded #s= schema payload. It does not fetch a revocable #g= cloud share. Export the native schema from the browser when you need a file-based CI input. Invalid generation inputs are reported on standard error with a nonzero exit status; let that fail the job rather than committing an empty output.

Follow the QA fixture workflow, the database seed workflow, or the local MCP setup. The methodology documents output limits.

Last updated