https://github.com/niktheblak/teleport
Directory navigation tool for *nix shells
https://github.com/niktheblak/teleport
directory go golang navigation shell shell-script
Last synced: 3 months ago
JSON representation
Directory navigation tool for *nix shells
- Host: GitHub
- URL: https://github.com/niktheblak/teleport
- Owner: niktheblak
- License: agpl-3.0
- Created: 2017-02-27T13:59:33.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2026-03-06T09:16:19.000Z (4 months ago)
- Last Synced: 2026-03-06T13:43:28.662Z (4 months ago)
- Topics: directory, go, golang, navigation, shell, shell-script
- Language: Go
- Homepage:
- Size: 148 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# teleport
Directory navigation tool for *nix shells. Contributions for integrations to different shells welcome!
## Usage
Start by building the `teleport` binary and copying it to your executable path.
You also need to copy the shell script to Fish shell's (TODO: support for other shells) `functions` directory.
```shell
$ go build cmd/teleport/teleport.go
$ cp teleport ~/bin
```
If you're using Bash shell, load the file `scripts/bash/tp.sh` into your current Bash session
or do it in your `.profile` file:
```shell
$ source scripts/bash/tp.sh
```
If you're using Fish shell, copy the file `scripts/fish/tp.fish` under your Fish functions:
```shell
$ cp scripts/fish/tp.fish ~/.config/fish/functions/
```
Now you can see the available commands with the `tp` command.
After this you can create teleport points to your favorite directories with `tp add`.
## Adding a teleport point
tp add {name} [directory]
Omitting [directory] will add a teleport point to the current directory.
For example:
```shell
$ cd ~/projects/go/my_fav_proj
$ tp add fav
$ cd
$ tp fav
# pwd is now at ~/projects/go/my_fav_proj
```
## Listing teleport points
tp list
For example:
```shell
$ tp list
```