# litic > Perform technical SEO analysis to your website. Latest version **1.1.0** (published 2021-01-22) · ISC license · 0 weekly downloads ## Install ```sh npm install litic pnpm add litic yarn add litic bun add litic ``` Provides the command `litic`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2021-01-22 | | First published | 2021-01-17 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 12 | | Unpacked size | 108.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 8 | | Author | Raúl López | | Maintainers | rulilg | | Keywords | seo, technical, seo, automated, testing, accessibility, best practices, security | ## Links - npm: https://www.npmjs.com/package/litic - Repository: https://github.com/RuliLG/Litic - Homepage: https://github.com/RuliLG/Litic#readme - Issues: https://github.com/RuliLG/Litic/issues - npm.io page: https://npm.io/package/litic ## Dependencies (12) - [dayjs](https://npm.io/package/dayjs.md) ^1.10.3 - [whois](https://npm.io/package/whois.md) ^2.13.3 - [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.5 - [argparse](https://npm.io/package/argparse.md) ^2.0.1 - [puppeteer](https://npm.io/package/puppeteer.md) ^5.5.0 - [csv-writer](https://npm.io/package/csv-writer.md) ^1.6.0 - [lighthouse](https://npm.io/package/lighthouse.md) ^7.0.0 - [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1 - [typescript](https://npm.io/package/typescript.md) ^4.1.3 - [html-minifier](https://npm.io/package/html-minifier.md) ^4.0.0 - [silverdiamond](https://npm.io/package/silverdiamond.md) ^1.4.0 - [html-validator](https://npm.io/package/html-validator.md) ^5.1.17 ## Alternatives - [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads - [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads - [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads - [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads - [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads ## Recent versions - 1.1.0 (latest) — 2021-01-22 - 1.0.0 — 2021-01-19 - 0.1.8 — 2021-01-17 - 0.1.7 — 2021-01-17 - 0.1.6 — 2021-01-17 - 0.1.5 — 2021-01-17 - 0.1.4 — 2021-01-17 - 0.1.3 — 2021-01-17 - 0.1.2 — 2021-01-17 - 0.1.1 — 2021-01-17 - 0.1.0 — 2021-01-17 ## README # Litic JS library to perform technical SEO and best practices analysis to your projects. > Note: This tool functionality relies on Google Lighthouse. It's such a great tool to test your web projects! ## Install Just run the npm install command: ```bash npm i litic -g ``` After the installation, you can use it via: ```bash litic -u "https://example.com/test-url" -k "my keyword" -o "output.csv" ``` ## Tests Litic currently analyses your website against 45 different tests, divided by category: Category|Test name ---|---- Performance | HTTP/2 Performance | Server Response Time Performance | Largest Contentful Paint Performance | Cumulative Layout Shift Performance | First Contentful Paint Performance | Time to Interactive Performance | HTML Minification Performance | Minified CSS Performance | Minified JS Performance | Optimized caching strategy Performance | Uses Text Compression Performance | Reduced DOM Size Performance | Lazy-load offscreen images Robots | Page is crawlable Accessibility | Jump to Main Content Accessibility | Matching HTML Language Accessibility | Color Contrast Accessibility | Image Alternative Text Accessibility | Appropiate size for tap targets Accessibility | Font size is greater than 12px Best Practices | HTML is valid Best Practices | Console errors Best Practices | <!DOCTYPE html> Best Practices | <html> has [lang] attribute Best Practices | Apple Touch Icon Best Practices | Javascript Links Best Practices | Empty Anchor Links Meta-tags | <meta charset="utf-8"> is used Meta-tags | <meta name="viewport"> is correctly used Meta-tags | <title> tag is present Meta-tags | meta[name="description"] Meta-tags | Canonical URL is defined Meta-tags | Document has a valid hreflang Content | Heading structure Content | Content Width Content | Text Readability Content | Keywords (Text Rank) Content | BERT Score Security | No plain text emails Security | HTTPS Security | HTTPS Redirection Security | External links use [rel="noopener"] or [rel="noreferrer"] Security | Protect against MIME Sniffing Security | Protect against Clickjacking Other | Domain expiration Each test comes with a description, and most of them will also offer you a link with more information. ## Usage To use Litic, you can just run an analysis with `litic -u "https://your-url.com/"`. The results of this analysis will be printed on your console: ![Litic screenshot](https://user-images.githubusercontent.com/3358390/105087404-5011c900-5a92-11eb-87bc-7954584ae7f8.png) Additionally, you can also use other parameters, such as `-o` to specify the path where you want to store the results, or `-k` to specify a keyword to run content checks against. Short name | Long name | Description | Required ---|---|---|--- -u|--url|URL to run the tests against|Yes -k|--keyword|Keyword to run content checks against|No -o|--output|Output path for a CSV file with the results|No ## Running remote If running under a low-resource environment, you can run the lighthouse analysis using [Google PageSpeed Insights API](https://developers.google.com/speed/docs/insights/v5/get-started). To do this, you just need to set the `PAGESPEED_TOKEN` environment variable to your API token, and Litic will use it to perform the remote analysis. ```bash PAGESPEED_TOKEN={YOUR_TOKEN} litic -u "https://example.com" ``` ## Smart tests There are a few tests that rely on [Silver Diamond](https://silverdiamond.io) to execute. To use them, please register and set an environment variable named `SD_KEY` to your api key. ```bash SD_KEY={API_KEY} litic -u "https://example.com" ``` ## Roadmap There are a lot of tests I want to include in Litic, as well as making it possible to provide a list of URLs (or even an excel with tons of URLs) and run the tests against each one of them. ## Contributions Please, feel free to contribute to this repository, making pull requests or opening new issues. ## License Copyright © 2021 Raúl López and contributors Licensed under the MIT license, see LICENSE for details. --- _Source: https://npm.io/package/litic · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._