Skip to main content

Automagic ctrl+t filename completion to launch in your favorite editor

Project description

completeme

completeme is a python script that’ll allow you to auto-complete filenames and launch them in an editor, much like GitHub’s ‘t’ keyboard shortcut. Rather than tab-completing to oblivion (ever worked on a Java project?), just start typing the name of the file, and when you hit ‘enter’, it’ll open that file in your favorite $EDITOR. If you hit ‘tab’, the filename will be entered back into the command line.

Uses files stored in the current GitHub repository and falls back on all files below the current working directory.

Make sure to add `source /usr/local/bin/setup_completeme_key_binding.sh` to your .bashrc to enable Ctrl+t support!

Configuration

completeme comes with (wherever-pip-installs-the-completeme-python-package)/completeme.json, which you can use to, well, configure your completeme experience.

  • git_entire_tree (default=true) indicates whether, if we’re in a git repository, we should search all files in the git repository, regardless of where we are in said repository. That is, if we have a repository like /hello.txt, /a/there.txt, /b/myfriends.txt, and we’re in the /a directory, git_entire_tree=true implies that we’ll also surface /hello.txt and /b/myfriends.txt. Otherwise, you’ll just get /a/there.txt.

  • find_hidden_directories (default=false) indicates whether we should search inside dot directories (assuming we didn’t find a git repository). These are things like .config/, .vim/, etc.

  • find_hidden_files (default=false) indicates whether we should find files that start with a dot (assuming we didn’t find a git repository). These are things like .emacs, .xinitrc, .DS_Store, etc.

Known Issues

  • Mac OS X ships with bash 3.2, which doesn’t use the READLINE_LINE or READLINE_POINT variables. Unless you upgrade, you won’t be able to use the tab-functionality to drop the filename back into the prompt! Fortunately, brew install bash will give you a compatible version!

License

This software is licensed under the WtHYWv2 (Whatever the Hell You Want, v2). Please throw some credit around if it’s deserved.

Thanks

Thank you to all who have contributed ideas and feedback. Special thanks to those listed below!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

completeme-0.4.7.tar.gz (11.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page