{"id":30135378,"url":"https://github.com/karelklima/workflowy","last_synced_at":"2026-01-12T15:17:37.910Z","repository":{"id":161984839,"uuid":"636579245","full_name":"karelklima/workflowy","owner":"karelklima","description":"WorkFlowy API for Deno and Node","archived":false,"fork":false,"pushed_at":"2025-08-10T15:41:55.000Z","size":80,"stargazers_count":45,"open_issues_count":3,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-10T16:06:20.960Z","etag":null,"topics":["api","client","workflowy"],"latest_commit_sha":null,"homepage":"https://jsr.io/@workflowy/workflowy","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/karelklima.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":"karelklima"}},"created_at":"2023-05-05T07:07:11.000Z","updated_at":"2025-08-10T15:41:12.000Z","dependencies_parsed_at":"2024-10-30T20:01:54.620Z","dependency_job_id":"bffe7bc3-86a1-41af-982d-0babd6d926a4","html_url":"https://github.com/karelklima/workflowy","commit_stats":{"total_commits":23,"total_committers":2,"mean_commits":11.5,"dds":0.04347826086956519,"last_synced_commit":"b30cef1cc4628c1326536e47c2f6f8de6946893a"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/karelklima/workflowy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karelklima%2Fworkflowy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karelklima%2Fworkflowy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karelklima%2Fworkflowy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karelklima%2Fworkflowy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karelklima","download_url":"https://codeload.github.com/karelklima/workflowy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karelklima%2Fworkflowy/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269749640,"owners_count":24469403,"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-08-10T02:00:08.965Z","response_time":71,"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":["api","client","workflowy"],"created_at":"2025-08-10T22:27:18.291Z","updated_at":"2026-01-12T15:17:32.890Z","avatar_url":"https://github.com/karelklima.png","language":"TypeScript","funding_links":["https://github.com/sponsors/karelklima"],"categories":[],"sub_categories":[],"readme":"# WorkFlowy API\n\nThis is a [WorkFlowy](https://workflowy.com) client for Deno and Node. The goal\nof this library is to enable WorkFlowy power users to access WorkFlowy lists\nprogramatically and perhaps create some new automations and integrations.\n\n## Features\n\n- Reading and updating WorkFlowy lists\n- Export of lists to JSON or formatted plain text\n- Basic search of items in lists\n- Support for live copies (mirrors)\n\n## Basic usage\n\n### Authentication\n\nIn order to access WorkFlowy content, you need to provide your WorkFlowy\nusername and password. Authentication via one-time code or two-factor\nauthentication are not supported because of technical limitations of WorkFlowy\nAPI.\n\n### Fetching a WorkFlowy document\n\n```typescript\nimport { WorkFlowy } from \"workflowy\";\n\n// Log in with your username and password\nconst workflowy = new WorkFlowy(\"your@email.com\", \"your-password\");\n// Load WorkFlowy outline into an interactive document structure\nconst document = await workflowy.getDocument();\n```\n\n### Finding lists in a document\n\n```typescript\nconst rootList = document.root;\nconst topLevelLists = document.items; // array of lists in the root\nconst myList = topLevelLists[0];\n\nmyList.findOne(/^Needle/); // Finds a sublist using a RegExp\nmyList.findAll(/^Needle/); // Finds all sublists using a RegExp\n```\n\n### Accessing basic list properties\n\n```typescript\nconst rootList = document.root;\nconst myList = document.items[0];\n\nmyList.name; // name of the list\nmyList.note; // note of the list\nmyList.isCompleted; // whether or not the list or item is completed\nmyList.items; // items and sublists\n```\n\n### Editing lists\n\n```typescript\nmyList.setName(\"New name\").setNote(\"New note\"); // sets a name and a note\nconst sublist = myList.createList(); // Creates a sublist\nconst subitem = myList.createItem(); // Alias for createList\n\nmyList.move(targetList); // moves a list or item to a different list\nmyList.delete(); // deletes the list\n```\n\n### Saving the changes to WorkFlowy\n\n```typescript\nif (document.isDirty()) {\n  // Saves the changes if there are any\n  await document.save();\n}\n```\n\n## Installation\n\n### From `npm` (Node/Bun)\n\n```\nnpm install workflowy    # npm\nyarn add workflowy       # yarn\nbun add workflowy        # bun\npnpm add workflowy       # pnpm\n```\n\n### From `deno.land/x` (Deno)\n\nUnlike Node, Deno relies on direct URL imports instead of a package manager like\nNPM. The latest Deno version can be imported like so:\n\n```typescript\nimport { WorkFlowy } from \"https://deno.land/x/workflowy/mod.ts\";\n```\n\n## Acknowledgements\n\nBig thanks to [Mike Robertson](https://github.com/mikerobe) for providing the\n`workflowy` NPM package name!\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarelklima%2Fworkflowy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarelklima%2Fworkflowy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarelklima%2Fworkflowy/lists"}