{"id":18427975,"url":"https://github.com/radian-software/wdx","last_synced_at":"2025-04-07T16:34:06.730Z","repository":{"id":76717793,"uuid":"99072768","full_name":"radian-software/wdx","owner":"radian-software","description":"🚩 Like wd but different.","archived":false,"fork":false,"pushed_at":"2023-10-01T00:02:14.000Z","size":30,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-22T21:41:52.890Z","etag":null,"topics":["cd","productivity","python","zplug","zsh"],"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/radian-software.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2017-08-02T04:40:41.000Z","updated_at":"2024-12-08T19:34:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"7c56423b-3cd7-4090-bf08-bd3a3cfbbc44","html_url":"https://github.com/radian-software/wdx","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radian-software%2Fwdx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radian-software%2Fwdx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radian-software%2Fwdx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radian-software%2Fwdx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/radian-software","download_url":"https://codeload.github.com/radian-software/wdx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247688499,"owners_count":20979685,"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":["cd","productivity","python","zplug","zsh"],"created_at":"2024-11-06T05:12:24.353Z","updated_at":"2025-04-07T16:34:06.480Z","avatar_url":"https://github.com/radian-software.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"**`wdx`**: like [`wd`][wd] but different.\n\n## Summary\n\n`wdx` is a Zsh plugin which allows you to designate directories with\nabbreviations, and later use those abbreviations to jump to the\ndirectories.\n\n## Installing\n\nThe easiest way to install `wdx` is using [zinit]:\n\n    $ zplugin light radian-software/wdx\n\nOtherwise, you can install `wdx` manually:\n\n* Clone the `wdx` source repository.\n* Add the `bin` subdirectory to your PATH.\n* Source the file `wdx.zsh` in your `~/.zshrc`.\n\n## Basic usage\n\nHere is the command syntax:\n\n    usage: wdx [-s | --shell] \u003csubcommand\u003e\n\n    subcommands:\n      wdx [go] \u003cpoint\u003e\n      wdx show \u003cpoint\u003e\n      wdx set [\u003cpoint\u003e [\u003ctarget\u003e]] [-f | --force]\n      wdx rm [\u003cpoint\u003e]\n      wdx ls\n      wdx help [\u003csubcommand\u003e]\n      wdx version\n\nThe subcommands are as follows:\n\n* The `go` subcommand is used to `cd` to a target directory. If you\n  don't give any subcommand, then `wdx` assumes you meant `go`.\n* The `show` subcommand is used to print a target directory.\n* The `set` subcommand is used to set a warp point. The `-f` or\n  `--force` option allows you to overwrite an existing warp point by\n  the same name.\n* The `rm` subcommand is used to remove a warp point.\n* The `ls` subcommand is used to print a list of all the defined warp\n  point names. If you want to see the paths as well, you can just\n  inspect the save file (see below).\n\nAmbiguities are resolved like so:\n\n* If the warp point name is omitted in the `set` or `rm` subcommands,\n  then it defaults to the basename of the current directory\n  (`/foo/bar` becomes `bar`).\n* If the target directory is omitted in the `set` subcommand, then it\n  defaults to the current directory.\n* You must use `wdx go` explicitly in order to go to a warp point\n  whose name is also a `wdx` subcommand.\n* To deal with warp points and directories whose names begin with a\n  hyphen, you can use the `--` argument to prevent following arguments\n  from being interpreted as options.\n\nThe `-s`, `--shell` option causes `wdx` to print shell code to stdout\ninstead of performing the action directly. This feature is used\nimplicitly by the shell wrapper defined in `wdx.zsh`, so that the `go`\nsubcommand can actually change the working directory of your shell. It\nis probably not much use to the end user, unless you are bypassing the\nshell wrapper and working directly with the `wdx` script in the `bin`\nsubdirectory.\n\n## Save file format\n\nYour warp points are put in `$XDG_CONFIG_HOME/wdx/points`, or by\ndefault `~/.config/wdx/points`.\n\nThe file format is plain-text. Lines alternate between warp point\nnames and target directories. Any characters except newlines are\nallowed in point names and target paths. In particular, empty strings\nare allowed. Points are sorted first by target path, and then by point\nname.\n\nEditing the save file by hand is encouraged if you rename a parent\ndirectory, which will otherwise break your warp points.\n\nNote that warp point targets need not be absolute paths. They are not\nresolved at any time, but are saved and passed to `cd` unmodified.\n\n## Tips\n\nYou can use `wdx` with the name `wd` instead, simply by defining\n\n    alias wd=wdx\n\nin your `.zshrc`.\n\n## Why?\n\nBecause I thought the command-line interface of [`wd`][wd] was a bit\nmessy, and it didn't allow for arbitrary warp point names.\n\n[wd]: https://github.com/mfaerevaag/wd\n[zinit]: https://github.com/zdharma-continuum/zinit\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradian-software%2Fwdx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fradian-software%2Fwdx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradian-software%2Fwdx/lists"}