Sleuth is an open source tool that shows you Sketch library usage per file across your projects.

This is great for getting an idea about how well your design system sketch ui kit is being used, though it's not perfect as using any external library will generate a positive result on any layer or symbol.

Here's a report built from the sample directory

• Symbols
• Layer styles
• Text styles

1. Nodejs - This tool is built on Node.
2. Sketch - You need Sketch installed to process the files
3. Abstract (optional, but recommended) - If your team uses Abstract, you can automatically scan all of your team's projects. Make sure your Abstract projects are all synced before running.

1. Download this repo and extract it. (or fork it if you know what you're doing)
2. In Finder, locate where you extracted this repo
3. Right click on the folder
4. Select Services > New Terminal at Folder

The terminal window will open. This is where you will type any of the commands you need below.

npm install

npm run report -- abstract

This will download all sketch files from all active projects to a temporary directory and scan them to build reports.

1. Open EXAMPLE.env in a code editor (we like VSCode)
2. Log into abstract.com from a web browser
3. Select the org you want from the dropdown
4. Copy the id from your address bar... app.abstract.com/organizations/ [THIS IS YOUR ORG ID] /projects
5. Paste it into EXAMPLE.env
6. Get an Abstract API token
7. Paste it into EXAMPLE.env ** DO NOT PUBLISH YOUR API TOKEN TO A PUBLIC REPO**
8. Rename EXAMPLE.env to .env

npm run report -- ./sample #Replace ./sample with the directory of your sketch project files

Copy all the sketch files you want to scan into a directory with this folder structure. There is an example in this repo in /sample

Sketch project master folder
    |- PROJECT_NAME_1
    |   |- sketch_file1.sketch
    |   |- sketch_file2.sketch
    |- SECOND_PROJECT
        |- library.sketch
        |- second file.sketch
...

npm run dev

npm run build

Please read our Contribution Guidelines before making a pull request.

MIT

Copyright (c) 2019-present, Keap