{"id":19142286,"url":"https://github.com/eldoy/flekk","last_synced_at":"2026-06-11T21:35:29.754Z","repository":{"id":57238145,"uuid":"448801997","full_name":"eldoy/flekk","owner":"eldoy","description":"YAML API testing library","archived":false,"fork":false,"pushed_at":"2023-02-05T04:29:06.000Z","size":179,"stargazers_count":1,"open_issues_count":10,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-03T19:59:29.354Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eldoy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-17T07:58:41.000Z","updated_at":"2022-06-04T21:51:15.000Z","dependencies_parsed_at":"2023-02-18T21:45:46.532Z","dependency_job_id":null,"html_url":"https://github.com/eldoy/flekk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eldoy/flekk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fflekk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fflekk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fflekk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fflekk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eldoy","download_url":"https://codeload.github.com/eldoy/flekk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eldoy%2Fflekk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34219510,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-11T02:00:06.485Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T07:26:40.997Z","updated_at":"2026-06-11T21:35:29.738Z","avatar_url":"https://github.com/eldoy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flekk\n\nLow code testing library. Test your APIs using only YAML.\n\n### Install\n\n```\nnpm i -g flekk\n```\n\n### Files\n\nAll test and setup files live in the `$APP_ROOT/test` directory, and written with [weblang.](https://github.com/eldoy/weblang)\n\nTest files must end with `.test.yml`, for example `project.test.yml`. Setup files, which can be included in test files, must end with `.setup.yml`, like in `login.setup.yml`.\n\n### Config\n\nConfig files must end in `.config.yml`, like in `app.config.yml`.\n\nThe default config file should be added in `$APP_ROOT/test/flekk.config.yml`:\n```yml\n# The URL and port of the app you are testing\nurl: http://localhost\nport: 5061\n\n# Database setup for the db command, requires mongodb\ndb:\n  name: flekk-test\n```\n\nThe default config file is always loaded, and then other config files are merged on top of that.\n\n### Commands\n\nThere are 6 basic commands:\n\n* __config__ - load config files\n* __setup__  - run setup files\n* __api__    - query an action endpoint\n* __db__     - access the database\n* __test__   - test a value\n* __log__    - log a value to console\n\nThis is how to use them:\n\n```yml\n# Load config file\n@config: app\n\n# Load multiple config files, will be merged\n@config:\n  - app\n  - remote\n\n# Run setup file\n@setup: login\n\n# Run multiple setup files\n@setup:\n  - create-user\n  - login\n\n# Test the site/create API\n@api$result:\n  action: site/create\n  values:\n    name: hello\n  auth: $auth\n@test$result:\n  id:\n    is: id\n\n# Test database values\n@db$site:\n  action: site/get\n  query:\n    id: $result.id\n@test$site:\n  id:\n    required: true\n\n# Print value to terminal\n$hello: world\n@log: $hello\n```\n\n### Setup\n\nRun the tests with:\n```\n# Run all tests\nflekk\n\n# Run matching tests\nflekk names\n\n# With nodemon\nnodemon -e js,mjs,json,yml,css,md --exec flekk\n```\n\nAdd this to you `package.json` file to run with `npm`:\n```json\n\"scripts\": {\n  \"test\": \"nodemon -q -e js,mjs,json,yml,css,md --exec flekk\"\n}\n```\nThen run with `npm run test` in your application.\n\nMIT Licensed. Enjoy!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feldoy%2Fflekk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feldoy%2Fflekk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feldoy%2Fflekk/lists"}