{"id":13760685,"url":"https://github.com/nitwof/izer","last_synced_at":"2025-05-10T11:30:36.858Z","repository":{"id":64304116,"uuid":"207621160","full_name":"nitwof/izer","owner":"nitwof","description":"Command-line tool for adding icons to filenames","archived":false,"fork":false,"pushed_at":"2020-05-27T22:22:36.000Z","size":123,"stargazers_count":7,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-06-12T08:20:02.846Z","etag":null,"topics":["cli","fzf","go","izer","unix","vim"],"latest_commit_sha":null,"homepage":"","language":"Go","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/nitwof.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}},"created_at":"2019-09-10T17:24:38.000Z","updated_at":"2024-06-12T08:20:02.846Z","dependencies_parsed_at":"2023-01-15T10:15:50.975Z","dependency_job_id":null,"html_url":"https://github.com/nitwof/izer","commit_stats":null,"previous_names":["nightwolf007/izer"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitwof%2Fizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitwof%2Fizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitwof%2Fizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitwof%2Fizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nitwof","download_url":"https://codeload.github.com/nitwof/izer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224732163,"owners_count":17360416,"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":["cli","fzf","go","izer","unix","vim"],"created_at":"2024-08-03T13:01:16.810Z","updated_at":"2024-11-16T17:31:44.045Z","avatar_url":"https://github.com/nitwof.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# izer\n\n[![Build Status](https://github.com/NightWolf007/izer/workflows/build/badge.svg)](https://github.com/NightWolf007/izer)\n[![codecov](https://codecov.io/gh/NightWolf007/izer/branch/master/graph/badge.svg)](https://codecov.io/gh/NightWolf007/izer)\n\nizer is a command-line tool for adding icons to filenames.\n\nizer is heavily inspired by [VimDevIcons](https://github.com/ryanoasis/vim-devicons).\n\n\u003cimg src=\"images/preview.png\" width=700\u003e\n\n## Pros\n\n- Portable, no dependencies\n- Fast\n- Icon sets for different fonts\n- Colored icons\n- Deiconize feature for removing icons from filenames\n- Smooth integration with [fzf](https://github.com/junegunn/fzf)\n\n## Benchmark\n\n```shell\nBenchmarkDeiconize-8                          10        1118691512 ns/op\n--- BENCH: BenchmarkDeiconize-8\n    deiconize_bench_test.go:28: Input size: 44148 KB - 1356000 lines\nBenchmarkIconize/Nerd-8                       10        1301644333 ns/op\nBenchmarkIconize/NerdColor-8                  10        1567274214 ns/op\nBenchmarkIconize/NerdDir-8                    10        1829822057 ns/op\nBenchmarkIconize/NerdDirColor-8               10        2202257278 ns/op\n--- BENCH: BenchmarkIconize\n    iconize_bench_test.go:32: Input size: 19472 KB - 1356000 lines\n```\n\n## Installation\n\n### From binaries\n\nThe [release page](https://github.com/NightWolf007/izer/releases) includes\nprecompiled binaries for Linux, FreeBSD, macOS and Windows.\n\n### Using Go\n\n```shell\ngo get -u github.com/NightWolf007/izer\n```\n\n## Usage\n\n### Iconize\n\n`iconize` command adds icons to filenames.\nYou can pass filenames to command through stdin or as arguments.\n\n#### Command-line options\n\n```shell\nUsage:\n  izer iconize [flags]\n\nFlags:\n  -c, --color         Enable colorful output\n  -d, --dir           Enable icons for directories (Slows down the process due checking files)\n  -f, --font string   Font to be used. See: izer fonts\n  -h, --help          help for iconize\n```\n\n#### Simple usage\n\n```shell\n# Using arguments\nizer iconize -f=nerd somefile.go somefile2.py\n\n# Using stdin\nfind . | izer iconize -f=nerd\n```\n\n#### Directory icons\n\nChecking that filename is directory or not slows down the iconization process.\nThus, by default izer handles directories as a simple files.\n\nTo enable directory icons use `-d` opton.\n\n```shell\n# Using arguments\nizer iconize -f=nerd -d somedir somefile.go\n\n# Using stdin\nfind . | izer iconize -f=nerd -d\n```\n\n#### Colored icons\n\n`-c` option prints icons in ANSI colors\n\n```shell\n# Using arguments\nizer iconize -f=nerd -c somefile.go somefile2.py\n\n# Using stdin\nfind . | izer iconize -f=nerd -c\n```\n\n### Deiconize\n\n`deiconize` command removes icons from filenames (undoing iconize command).\nYou can pass filenames to command through stdin or as arguments.\n\n```shell\n# Using arguments\nizer deiconize \" somefile.go\" \" somefile.py\"\n\n# Using stdin\nfind . | izer iconize -f=nerd | izer deiconize\n```\n\n### Supported fonts\n\nTo show list of all supported fonts use `fonts` command.\n\n```shell\nizer fonts\n```\n\n### Using izer with [fzf](https://github.com/junegunn/fzf)\n\nYou can use izer to iconize files in fzf.\n\n```shell\n# Set default preview command\nexport FZF_DEFAULT_PREVIEW=\"fd --type file | izer iconize -f=nerd -c\"\n\n# Run fzf\nfzf | izer deiconize\n\n# Run fzf with preview\nfzf --preview 'bat $(izer deiconize {})' | izer deiconize\n```\n\nMore info about fzf usage [here](https://github.com/junegunn/fzf#usage).\n\n## Development\n\n### Prerequisites\n\n- Go 1.13\n- [gomplate](https://github.com/hairyhenderson/gomplate)\n- [golangci-lint](https://github.com/golangci/golangci-lint)\n\n### Building\n\n```shell\n# Build izer binary\nmake\n\n# Generate font files and test inputs from mappings\nmake generate\n```\n\n### Linting\n\n```shell\n# Using make\nmake lint\n\n# Alternatively, you can run golangci-lint directly\ngolangci-lint run\n```\n\n### Testing\n\n```shell\n# Run all tests\nmake test\n\n# Run integration tests\nmake itest\n\n# Update test golden files\nmake goldens\n```\n\n### Benchmarking\n\n```shell\n# Run integration benchmarks\nmake bench\n\n# Also, you can pass benchtime through variable\nBENCHTIME=10x make bench\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitwof%2Fizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnitwof%2Fizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitwof%2Fizer/lists"}