{"id":13794249,"url":"https://github.com/JakePartusch/lumberjack","last_synced_at":"2025-05-12T20:31:42.606Z","repository":{"id":54420443,"uuid":"238521083","full_name":"JakePartusch/lumberjack","owner":"JakePartusch","description":"An automated website accessibility scanner and cli","archived":false,"fork":false,"pushed_at":"2023-03-03T12:48:37.000Z","size":356,"stargazers_count":128,"open_issues_count":4,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-19T08:05:22.769Z","etag":null,"topics":["a11y","accessibility","axe","cli","crawler","lumberjack"],"latest_commit_sha":null,"homepage":"https://github.com/JakePartusch/lumberjack","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/JakePartusch.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-02-05T18:34:27.000Z","updated_at":"2025-03-19T17:54:10.000Z","dependencies_parsed_at":"2024-01-07T06:05:20.503Z","dependency_job_id":"a3af12d9-2110-4f35-9366-c52ad2a9e3a5","html_url":"https://github.com/JakePartusch/lumberjack","commit_stats":{"total_commits":33,"total_committers":3,"mean_commits":11.0,"dds":0.06060606060606055,"last_synced_commit":"b9ac8b1c1c73aad79be0f832990af5a916966739"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakePartusch%2Flumberjack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakePartusch%2Flumberjack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakePartusch%2Flumberjack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JakePartusch%2Flumberjack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JakePartusch","download_url":"https://codeload.github.com/JakePartusch/lumberjack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253816782,"owners_count":21968880,"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","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":["a11y","accessibility","axe","cli","crawler","lumberjack"],"created_at":"2024-08-03T23:00:37.741Z","updated_at":"2025-05-12T20:31:42.109Z","avatar_url":"https://github.com/JakePartusch.png","language":"JavaScript","readme":"\u003ch1 align=\"center\"\u003e\n  Lumberjack\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  Chop down accessibility issues with this full-website accessibility scanner\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./.github/undraw_winter_activities_vv0v.png\" alt=\"Woman in winter attire standing with an ax next to a tree\" width=\"350px\"/\u003e\n\u003c/p\u003e\n\n# About\n\nLumberjack runs [axe](https://www.deque.com/axe/) accessibility checks on your entire website!\n\n- Reads your website's sitemap\n- Spawns multiple browser instances and starts scanning with axe\n- Aggregates results and reports back\n  \u003cp\u003e\n    \u003cimg src=\"./.github/cli-screenshot.png\" alt=\"Screenshot of lumberjack in action. Print the individual accessibility issues found in an example\" /\u003e\n  \u003c/p\u003e\n\n# Usage\n\n## CLI\n\nNPX (recommended for a single run)\n\n```\nnpx @jakepartusch/lumberjack --url https://google.com\n```\n\nGlobal Install (recommended for multiple runs)\n\n```\nnpm install -g @jakepartusch/lumberjack\nlumberjack --url https://google.com\n```\n\n### Options\n\n```\n--url         // Required — The base url to scan. If a sitemap exists, its pages will be scanned as well\n--strict      // Optional (default: false) — Fail the process if any accessibility issues are found\n--baseUrlOnly // Optional (default: false) — Skip the sitemap scan and only run the audit on the base url\n```\n\n## JavaScript\n\n```\nnpm install @jakepartusch/lumberjack\n```\n\n```\nconst lumberjack = require('@jakepartusch/lumberjack');\n\nconst myFunction = async () =\u003e {\n  const results = await lumberjack(\"https://google.com\");\n  console.log(results);\n}\n```\n\n## Continuous Integration\n\nGitHub Actions Example\n(eg. \".github/workflows/accessibility.yml\")\n\n```\nname: Accessibility Audits\n\non: [push]\n\njobs:\n  build:\n    runs-on: ubuntu-18.04\n\n    steps:\n      - uses: actions/checkout@v1\n      - name: Install required Linux packages\n        run: |\n          sudo apt-get update\n          sudo apt-get install libgbm-dev\n          sudo apt-get install xvfb\n      - name: Use Node.js 12.x\n        uses: actions/setup-node@v1\n        with:\n          node-version: 12.x\n      - name: Install npm packages\n        run: |\n          npm ci\n      - name: Build\n        run: |\n          npm run build\n      - name: Accessibility Audits\n        run: |\n          npm install -g @jakepartusch/lumberjack\n          xvfb-run --auto-servernum lumberjack --url https://google.com\n\n```\n","funding_links":[],"categories":["Accessibility"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJakePartusch%2Flumberjack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJakePartusch%2Flumberjack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJakePartusch%2Flumberjack/lists"}