mac-open
v0.1.3
Published
Opens files from a shell via mac's open command.
Downloads
242
Maintainers
Readme
mac-open
Opens files via Mac OS's open Shell Command. By default, opens each file using the default application for that file. If the file is in the form of a URL, the file will be opened as a URL.
This is for Mac OS's open command only. If you're looking for a cross platform open command take a look at node-open. The difference is, that this command allows for options to pass to the open command.
Options
All options are passed directly to the open
command.
$ open
Usage: open [-e] [-t] [-f] [-W] [-R] [-n] [-g] [-h] [-b <bundle identifier>] [-a <application>] [filenames] [--args arguments]
Help: Open opens files from a shell.
By default, opens each file using the default application for that file.
If the file is in the form of a URL, the file will be opened as a URL.
Options:
-a Opens with the specified application.
-b Opens with the specified application bundle identifier.
-e Opens with TextEdit.
-t Opens with default text editor.
-f Reads input from standard input and opens with TextEdit.
-F --fresh Launches the app fresh, that is, without restoring windows. Saved persistent state is lost, excluding Untitled documents.
-R, --reveal Selects in the Finder instead of opening.
-W, --wait-apps Blocks until the used applications are closed (even if they were already running).
--args All remaining arguments are passed in argv to the application's main() function instead of opened.
-n, --new Open a new instance of the application even if one is already running.
-j, --hide Launches the app hidden.
-g, --background Does not bring the application to the foreground.
-h, --header Searches header file locations for headers matching the given filenames, and opens them.
Usage Examples
Install the module with: npm install mac-open
var open = require('mac-open');
// Open URL with default Browser
open("http://www.google.com");
// Open file with Finder
open("/path/to/folder/file", { a: "Finder" }, function(error) {});
// Open file with Sublime Text in the background
open("/path/to/folder/file", { a: "Sublime Text 2", g: true }, function(error) {});
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
Copyright (c) 2013 We Are Interactive under the MIT license.