- CONFIGURATION AND ENVIRONMENT
- BUGS AND LIMITATIONS
- LICENSE AND COPYRIGHT
App::VTide - A vim/tmux based IDE for the terminal
This documentation refers to App::VTide version 0.1.15
vtide [start] [project] vtide (init|start|edit|run|conf|grep|recent|split|refresh|save|help) [options] COMMANDS: conf Show editor config settings edit Run vim for a group of files grep Run grep against configured globs help Show help for vtide sub commands init Initialise a new project recent List recently run vtide sessions refresh Refreshes the autocomplete cache run Run a projects terminal command save Make/Save changes to a projects config file split Simply split up a tmux widow (using the same syntax as the config) start Open a project in Tmux Examples: # start a new project, name taken from the directory name vtide init # start a new project specifying the project name vtide init --name my-project # start the project in the current directory vtide start # start the "my-project" project previously initialised vtide start my-project # Shortcuts # When not in a tmux session starting a new session vtide my-project # When in a tmux session you can run edit with out specifying it vtide my-glob
VTide provides a way to manage tmux sessions. It allows for an easy way to configure a session window and run programs or open files for editing in them. The aim is to allow for easy project setup and management for projects managed on the command line. App::VTide also includes helpers for loading files into editors (such as vim) in separate tmux terminals. This can help to open pre-defined groups of files.
One piece of work == one project == one terminal tab. In one terminal tmux is run with tmux windows for editing different files, running commands and version control work.
Run the vtide commands
Loads the sub-command module and creates a new instance of it to return to the caller.
A full description of the configuration files can be found in App::VTide::Configuration.
There are no known bugs in this module.
Please report problems to Ivan Wills (email@example.com).
Patches are welcome.
Ivan Wills - (firstname.lastname@example.org)
Copyright (c) 2016 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.