Installing Hyperkey

Using Hyperkey without installing

NOTE: It is not necessary to install Hyperkey in order to use it occasionally.
Hyperkey works fine without ever being installed. It can be launched at any time by double-clicking on the 'start_hyperkey.bat' icon within its main folder.
This method of using Hyperkey can be very handy, because it is very portable. For example, Hyperkey can be added to a small USB drive, and carried anywhere. Everything that Hyperkey needs is contained in a single folder, including all of the backups and archives.
The Hyperkey folder including its archives can be copied to any desired location, and will work the same way in the new location.

Why install Hyperkey?

Installing Hyperkey makes sense when you have a central server such as a network-attached-storage (NAS) device, or for computers where you would be using the shortcut, backup or retrieval capabilities of Hyperkey frequently.
When installed, Hyperkey can share resources across a LAN, and the program can be invoked using the right-click menu in Windows. It is also available in any cmd.exe window, and can be used in conjunction with other batch files.

Installing Hyperkey

To install Hyperkey, it is necessary to execute the installation script in a command window that is in 'as Administrator' mode.
1. Copy the Hyperkey folder to where you wish to have it installed. For example, it could be copied to 'C:\Common\Hyperkey'.
2. In Windows Explorer, open the subfolder 'setup' within the Hyperkey folder, then right-click on the file 'setup.bat'.
3. Choose 'Run as administrator' from the right-click menu. This will launch the Hyperkey installer program.
4. You will first be asked where to install Hyperkey. For example:
  - --------------------------------------------
    HYPERKEY INSTALLER VER DEBUG 1.0
    --------------------------------------------
    INSTALLING INTO DIR |C:\Common\Hyperkey|
    
    INSTALL HYPERKEY IN |C:\Common\Hyperkey| [y]?
  - If you respond with 'y', it will install Hyperkey at its current location.
  - If you respond with 'n', you will be prompted for where to install it. For example:
  - INSTALL HYPERKEY IN |C:\Common\Hyperkey| [y]? n
    ENTER INSTALLATION LOCATION
    ? C:\Shared\Hyperkey
5. You will then be asked if you wish to add the Hyperkey path to the system 'PATH' environment variable. If you answer 'y', the Hyperkey features will be available in any command prompt window (i.e. cmd.exe).
  - ADD |C:\Common\Hyperkey| TO PATH? [n] y
6. Next you will be asked if you wish Hyperkey to be available on the Windows right-click menu. This can be very handy, as Hyperkey can be launched using a mouse.
  - ADD HYPERKEY TO RIGHT-CLICK MENU? [n] y
7. Finally, you will be asked to confirm that you wish to update your system. If you answer 'y' to this, the changes will be applied.
  - --------------------------------------------
    WILL INSTALL HYPERKEY IN DIRECTORY
    |C:\Common\Hyperkey|
    --------------------------------------------
    
    OK TO UPDATE SYSTEM (y/n) [n]? y
    
    INSTALL COMPLETE
    Press any key to continue . . .
8. Hit the 'Enter' key to close 'setup.bat'

Previous: Basic Hyperkey Commands Next: Hkeydb Command

	Installing Hyperkey
	Introduction Introduction The Basics Hyperkey Database Basics Adding Keys Basic Hyperkey Commands Setup Installing Hyperkey Hkeydb Command Database 'new' Sub-command Database 'init' Sub-command Hyperkey Commands Advanced Commands Backup Command Diffkey Command Restore Command Get Command Put Command Findkey Command Database Records Database Records Database Record Examples

	Using Hyperkey without installing NOTE: It is not necessary to install Hyperkey in order to use it occasionally. Hyperkey works fine without ever being installed. It can be launched at any time by double-clicking on the 'start_hyperkey.bat' icon within its main folder. This method of using Hyperkey can be very handy, because it is very portable. For example, Hyperkey can be added to a small USB drive, and carried anywhere. Everything that Hyperkey needs is contained in a single folder, including all of the backups and archives. The Hyperkey folder including its archives can be copied to any desired location, and will work the same way in the new location. Why install Hyperkey? Installing Hyperkey makes sense when you have a central server such as a network-attached-storage (NAS) device, or for computers where you would be using the shortcut, backup or retrieval capabilities of Hyperkey frequently. When installed, Hyperkey can share resources across a LAN, and the program can be invoked using the right-click menu in Windows. It is also available in any cmd.exe window, and can be used in conjunction with other batch files. Installing Hyperkey To install Hyperkey, it is necessary to execute the installation script in a command window that is in 'as Administrator' mode. Copy the Hyperkey folder to where you wish to have it installed. For example, it could be copied to 'C:\Common\Hyperkey'. In Windows Explorer, open the subfolder 'setup' within the Hyperkey folder, then right-click on the file 'setup.bat'. Choose 'Run as administrator' from the right-click menu. This will launch the Hyperkey installer program. You will first be asked where to install Hyperkey. For example: -------------------------------------------- HYPERKEY INSTALLER VER DEBUG 1.0 -------------------------------------------- INSTALLING INTO DIR \|C:\Common\Hyperkey\| INSTALL HYPERKEY IN \|C:\Common\Hyperkey\| [y]? If you respond with 'y', it will install Hyperkey at its current location. If you respond with 'n', you will be prompted for where to install it. For example: INSTALL HYPERKEY IN \|C:\Common\Hyperkey\| [y]? n ENTER INSTALLATION LOCATION ? C:\Shared\Hyperkey You will then be asked if you wish to add the Hyperkey path to the system 'PATH' environment variable. If you answer 'y', the Hyperkey features will be available in any command prompt window (i.e. cmd.exe). ADD \|C:\Common\Hyperkey\| TO PATH? [n] y Next you will be asked if you wish Hyperkey to be available on the Windows right-click menu. This can be very handy, as Hyperkey can be launched using a mouse. ADD HYPERKEY TO RIGHT-CLICK MENU? [n] y Finally, you will be asked to confirm that you wish to update your system. If you answer 'y' to this, the changes will be applied. -------------------------------------------- WILL INSTALL HYPERKEY IN DIRECTORY \|C:\Common\Hyperkey\| -------------------------------------------- OK TO UPDATE SYSTEM (y/n) [n]? y INSTALL COMPLETE Press any key to continue . . . Hit the 'Enter' key to close 'setup.bat' Previous: Basic Hyperkey Commands Next: Hkeydb Command