{"id":21423480,"url":"https://github.com/theonethread/falkor-library","last_synced_at":"2026-03-15T13:20:50.006Z","repository":{"id":37804606,"uuid":"383139619","full_name":"theonethread/falkor-library","owner":"theonethread","description":"Shared operations library","archived":false,"fork":false,"pushed_at":"2023-06-21T15:41:26.000Z","size":515,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-10-13T09:08:10.995Z","etag":null,"topics":["falkor","library","operations"],"latest_commit_sha":null,"homepage":"https://falkor.world","language":"TypeScript","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/theonethread.png","metadata":{"funding":{"ko_fi":"falkor_framework","custom":"https://www.linkedin.com/in/barnabas-bucsy"},"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-07-05T12:50:03.000Z","updated_at":"2024-04-20T04:02:57.000Z","dependencies_parsed_at":"2025-07-14T09:08:15.293Z","dependency_job_id":null,"html_url":"https://github.com/theonethread/falkor-library","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/theonethread/falkor-library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonethread%2Ffalkor-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonethread%2Ffalkor-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonethread%2Ffalkor-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonethread%2Ffalkor-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theonethread","download_url":"https://codeload.github.com/theonethread/falkor-library/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theonethread%2Ffalkor-library/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279014483,"owners_count":26085535,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"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":["falkor","library","operations"],"created_at":"2024-11-22T21:16:30.525Z","updated_at":"2025-10-13T09:08:11.773Z","avatar_url":"https://github.com/theonethread.png","language":"TypeScript","funding_links":["https://ko-fi.com/falkor_framework","https://www.linkedin.com/in/barnabas-bucsy"],"categories":[],"sub_categories":[],"readme":"# **Falkor Operations Library**\n\n[![Npm Keywords](https://img.shields.io/github/package-json/keywords/theonethread/falkor-library \"Keywords\")](https://www.npmjs.com/package/@falkor/falkor-library \"Visit\") \u0026nbsp; [![Npm Package](https://img.shields.io/npm/v/@falkor/falkor-library \"Npm\")](https://www.npmjs.com/package/@falkor/falkor-library \"Visit\") \u0026nbsp; [![Node Version](https://img.shields.io/node/v/@falkor/falkor-library \"Node\")](https://nodejs.org/ \"Visit\") \u0026nbsp; [![Build](https://img.shields.io/github/workflow/status/theonethread/falkor-library/Falkor%20CI%20-%20Release \"Build\")](https://github.com/theonethread/falkor-library/actions \"Visit\") \u0026nbsp; [![Security](https://img.shields.io/github/workflow/status/theonethread/falkor-library/Falkor%20CI%20-%20Security?label=security \"Security\")](https://github.com/theonethread/falkor-library/actions \"Visit\") \u0026nbsp; [![Activity](https://img.shields.io/github/last-commit/theonethread/falkor-library \"Activity\")](https://github.com/theonethread/falkor-library \"Visit\") \u0026nbsp; [![Falkor Bundler](https://img.shields.io/npm/dependency-version/@falkor/falkor-library/dev/@falkor/falkor-bundler \"Falkor Bundler\")](https://www.npmjs.com/package/@falkor/falkor-bundler \"Visit\") \u0026nbsp; [![Typedoc](https://img.shields.io/npm/dependency-version/@falkor/falkor-library/dev/typedoc \"Typedoc\")](https://www.npmjs.com/package/typedoc \"Visit\") \u0026nbsp; [![Type Definitions](https://img.shields.io/npm/types/@falkor/falkor-library \"Typings\")](https://www.typescriptlang.org/ \"Visit\") \u0026nbsp; [![Snyk Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/theonethread/falkor-library \"Snyk\")](https://snyk.io/test/github/theonethread/falkor-library \"Visit\") \u0026nbsp; [![License](https://img.shields.io/npm/l/@falkor/falkor-library \"MIT\")](https://github.com/theonethread/falkor-library/blob/master/license.txt \"Visit\")\n\nThe `falkor-library` project is a collection of devops tools written in strict ES6 TypeScript to be used with the **Falkor Framework**.\n\n## **Usage**\n\nSee the following projects consuming the `falkor-library`:\n\n- [`@falkor/falkor-commander`](https://www.npmjs.com/package/@falkor/falkor-commander \"Visit\"): plugin based task runner / -sequencer\n- [`falkor-plugin-example`](https://github.com/theonethread/falkor-plugin-example/tree/master \"Visit\"): example `falkor-commander` plugin to demonstrate framework capabilities\n\n### **Configuration**\n\nThe `falkor-library` looks for shared configurations in the Current Working Directory from where the application consuming it was executed (files could be named `.falkorrc`, `.ops.json`, `.ops.jsonc`, `falkor.json`, or `falkor.jsonc` - whichever is found first).\n\nTo see all available settings, and also example `falkor-commander` and plugin customizations check out the big [`.ops.jsonc`](https://github.com/theonethread/falkor-plugin-example/blob/develop/.ops.jsonc \"Open\") file provided as example in [`falkor-plugin-example`](https://github.com/theonethread/falkor-plugin-example \"Visit\").\n\n## **Further Development**\n\nThe project uses the [`@falkor/falkor-bundler`](https://www.npmjs.com/package/@falkor/falkor-bundler \"Visit\") module to compile sources. To clone the repository and compile `falkor-library` one can use the commands:\n\n```\n$ git clone --branch develop git@github.com:theonethread/falkor-library.git\n$ cd falkor-library\n$ npm install\n$ npm run [ debug | release ]\n```\n\n\u003e _**SEE:** `\"scripts\"` entry in [`package.json`](https://github.com/theonethread/falkor-library/blob/master/package.json \"Open\") for further reference._\n\n\u003e _**NOTE:** Compiling the `develop` sources might need locally linked `develop` versions of downstream module:_\n\u003e\n\u003e - _[`@falkor/falkor-bundler`](https://github.com/theonethread/falkor-bundler/tree/develop \"Visit\")_\n\u003e\n\u003e _**SEE:** [`npm-link`](https://docs.npmjs.com/cli/v7/commands/npm-link \"Visit\") for further reference._\n\n### **Documentation**\n\nTo generate HTML documentation from the TypeScript sources under the ignored `.doc` directory using [Typedoc](https://typedoc.org \"Visit\") run:\n\n```\n$ npm run doc\n```\n\nOr one can visit the exported [online documentation](https://theonethread.github.io/falkor-library-doc \"Visit\").\n\n### **Linting**\n\nThe project uses [`prettier`](https://www.npmjs.com/package/prettier \"Visit\") for code formatting and [`cspell`](https://www.npmjs.com/package/cspell \"Visit\") to avoid general typos in both sources and documentation - it is advised to install these packages as extensions in your IDE to prevent CI errors beforehand. To lint the project run:\n\n```\n$ npm run lint\n```\n\n\u003e _**SEE:** [`.prettierrc.cjs`](https://github.com/theonethread/falkor-library/blob/develop/.prettierrc.cjs \"Open\") and [`cspell.config.cjs`](https://github.com/theonethread/falkor-library/blob/develop/cspell.config.cjs \"Open\") for further reference._\n\n- To fix formatting issues run `$ npx prettier --write \u003cpath-to-file\u003e`. This will overwrite the file with the default formatting applied locally, so then you can review the changes in `git` and **ensure those did not affect production artifacts**.\n- To fix spelling errors run `$ npx cspell lint --wordsOnly --unique --gitignore --exclude .git ** .*` for details, and either make the fixes in the sources listed, add `cspell` favored comments, or extend the project-wide `cspell.config.cjs` accordingly.\n\n### **Versioning and Branching Strategy**\n\nRelease sources can be found on the `master` branch, this one always points to the latest tagged release. Previous sources of releases can be found using `git` version tags (or browsing GitHub releases). Released packages can be found on [npmjs](https://www.npmjs.com/package/@falkor/falkor-auth-server \"Visit\").\n\nThe repository's main branch is `develop` (due to technical reasons), this holds all developments that are already decided to be included in the next release. Usually this branch is ahead of `master` one patch version (but based on upcoming features to include this can become minor, or major), so prepared external links may yet be broken.\n\nThe `feature/*` branches usually hold ideas and POC code, these will only be merged into `develop` once their impact measured and quality meets release requirements.\n\n\u003e _The project uses [SemVer](https://semver.org \"Visit\"), `git` tags are prefixed with a `v` character._\n\n### **GitHub Actions**\n\nThe workflows can be found [here](https://github.com/theonethread/falkor-library/blob/develop/.github/workflows \"Open\").\n\n#### **Continuous Integration**\n\nAutomatic builds are achieved via GitHub actions, CI will make nightly builds of the `develop` branch (using Ubuntu image), and test `master` when there is a pull request, or commit on it (using Ubuntu - Win - MacOS image matrix).\n\n#### **API Documentation**\n\nThere is also a manually triggered workflow, that deploys generated documentation to [GitHub Pages](https://theonethread.github.io/falkor-library-doc \"Visit\").\n\n### **Security**\n\nThe project uses [CodeQL](https://codeql.github.com \"Visit\") and [Snyk](https://snyk.io \"Visit\") to ensure standard security.\n\n\u003e _The **Falkor Framework** supports a healthy and ubiquitous Internet Immune System enabled by security research, reporting, and disclosure. Check out our [Vulnerability Disclosure Policy](https://github.com/theonethread/falkor-library/security/policy \"Open\") - based on [disclose.io](https://disclose.io \"Visit\")'s best practices._\n\n### **Free and Open Source**\n\nThe latest sources can always be found on [GitHub](https://github.com/theonethread/falkor-library \"Visit\").\n\n#### **Getting Involved**\n\nWe believe - and we hope you do too - that learning how to code, how to think, and how to contribute to free- and open source software can empower the next generation of coders and creators. We **value** first time contributors just the same as rock stars of the OSS world, so if you're interested in getting involved, just head over to our [Contribution Guidelines](https://github.com/theonethread/.github/blob/master/.github/contributing.md \"Open\") for a quick heads-up!\n\n#### **License**\n\n[MIT](https://github.com/theonethread/falkor-library/blob/master/license.txt \"Open\")\n\n##\n\n---\n\n_©2020-2023 Barnabas Bucsy - All rights reserved._\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheonethread%2Ffalkor-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheonethread%2Ffalkor-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheonethread%2Ffalkor-library/lists"}