{"id":15969808,"url":"https://github.com/thombashi/pathvalidate-cli","last_synced_at":"2026-01-20T02:34:48.051Z","repository":{"id":195281703,"uuid":"692692773","full_name":"thombashi/pathvalidate-cli","owner":"thombashi","description":"pathvalidate-cli is a command line interface for pathvalidate library. The tool can do sanitize/validate a string such as file-names/file-paths.","archived":false,"fork":false,"pushed_at":"2023-09-17T14:01:07.000Z","size":14,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-17T00:01:48.672Z","etag":null,"topics":["filepath","linter","sanitization","validation-tool"],"latest_commit_sha":null,"homepage":"","language":"Python","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/thombashi.png","metadata":{"files":{"readme":"README.rst","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}},"created_at":"2023-09-17T09:33:22.000Z","updated_at":"2024-05-17T00:01:48.672Z","dependencies_parsed_at":"2023-09-17T09:52:15.414Z","dependency_job_id":"2cc2424a-6a69-483c-bb99-763f86a03aa0","html_url":"https://github.com/thombashi/pathvalidate-cli","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"36e9f99047a85a83f7a14d6e807b74b16c41443c"},"previous_names":["thombashi/pathvalidate-cli"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thombashi%2Fpathvalidate-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thombashi%2Fpathvalidate-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thombashi%2Fpathvalidate-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thombashi%2Fpathvalidate-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thombashi","download_url":"https://codeload.github.com/thombashi/pathvalidate-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246709880,"owners_count":20821298,"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":["filepath","linter","sanitization","validation-tool"],"created_at":"2024-10-07T19:41:47.405Z","updated_at":"2026-01-20T02:34:48.044Z","avatar_url":"https://github.com/thombashi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. contents:: **pathvalidate-cli**\n   :backlinks: top\n   :depth: 2\n\n\nSummary\n============================================\n\n``pathvalidate-cli`` is a command line interface for `pathvalidate \u003chttps://github.com/thombashi/pathvalidate\u003e`__ library.\nThe tool can sanitize/validate strings such as file-names/file-paths.\n\n|PyPI pkg ver| |Supported Python ver| |CI status| |CodeQL|\n\n.. |PyPI pkg ver| image:: https://badge.fury.io/py/pathvalidate-cli.svg\n    :target: https://badge.fury.io/py/pathvalidate-cli\n    :alt: PyPI package version\n\n.. |Supported Python ver| image:: https://img.shields.io/pypi/pyversions/pathvalidate-cli.svg\n    :target: https://pypi.org/project/pathvalidate-cli\n    :alt: Supported Python versions\n\n.. |CI status| image:: https://github.com/thombashi/pathvalidate-cli/actions/workflows/ci.yml/badge.svg\n    :target: https://github.com/thombashi/pathvalidate-cli/actions/workflows/ci.yml\n    :alt: CI status of Linux/macOS/Windows\n\n.. |CodeQL| image:: https://github.com/thombashi/pathvalidate-cli/actions/workflows/github-code-scanning/codeql/badge.svg\n    :target: https://github.com/thombashi/pathvalidate-cli/actions/workflows/github-code-scanning/codeql\n    :alt: CodeQL\n\n\nInstallation\n============================================\n::\n\n    pip install pathvalidate-cli\n\n\nUsage\n============================================\n\nSanitize file paths\n--------------------------------------------\n\n::\n\n    $ pathvalidate sanitize 'fi:l*e/p\"a?t\u003eh|.t\u003cxt'\n    file/path.txt\n    $ pathvalidate --filename sanitize 'fi:l*e/p\"a?t\u003eh|.t\u003cxt'\n    filepath.txt\n\nValidate file paths\n--------------------------------------------\n\n::\n\n    $ pathvalidate validate file/path.txt\n    $ \n    $ pathvalidate validate 'fi:l*e/p\"a?t\u003eh|.t\u003cxt'\n    [PV1100] invalid characters found: invalids=(':', '*', '\"', '?', '\u003e', '|', '\u003c'), value='fi:l*e/p\"a?t\u003eh|.t\u003cxt', platform=Windows\n\nCommand Help\n--------------------------------------------\n\n::\n\n    Usage: pathvalidate [OPTIONS] COMMAND [ARGS]...\n\n    Options:\n      --version                     Show the version and exit.\n      --debug                       For debug print.\n      -q, --quiet                   Suppress execution log messages.\n      --filename                    Consider inputs as filenames.\n      --max-len, --max-bytes BYTES  Maximum byte counts of file paths. -1: same\n                                    value as the platform limitation.  [default:\n                                    -1]\n      --platform PLATFORM           Target platform name (case-insensitive). Valid\n                                    platform specifiers are Linux/Windows/macOS.\n                                    Valid special values are: auto, universal,\n                                    POSIX (a) auto: automatically detects the\n                                    execution platform. (b) universal: platform\n                                    independent. (c) POSIX: POSIX-compliant\n                                    platform.  [default: universal]\n      -v, --verbose                 Verbosity level  [default: 0]\n      -h, --help                    Show this message and exit.\n\n    Commands:\n      error     Print error reasons.\n      sanitize  Sanitize file paths.\n      validate  Validate file paths.\n\n::\n\n    Usage: pathvalidate validate [OPTIONS] [FILEPATHS]...\n\n      Validate file paths.\n\n    Options:\n      --min-len, --min-bytes BYTES  Minimum byte counts of file paths.  [default:\n                                    1]\n      --no-check-reserved TEXT      Disable reserved name check.\n      -h, --help                    Show this message and exit.\n\n::\n\n    Usage: pathvalidate sanitize [OPTIONS] [FILEPATHS]...\n\n      Sanitize file paths.\n\n    Options:\n      --replacement-text TEXT    Replacement text for invalid characters. Defaults\n                                 to an empty string (remove invalid strings).\n                                 [default: \"\"]\n      --normalize                Normalize the path.\n      --validate-after-sanitize  Execute validation after sanitization.\n      -h, --help                 Show this message and exit.\n\n\nDependencies\n============================================\nPython 3.9+\n\n\nRelated Project\n============================================\n\n- `pathvalidate \u003chttps://github.com/thombashi/pathvalidate\u003e`__\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthombashi%2Fpathvalidate-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthombashi%2Fpathvalidate-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthombashi%2Fpathvalidate-cli/lists"}