|
| 1 | + |
| 2 | + |
1 | 3 | # guppy |
2 | | -Guppy is a simple tool for opening files in Google Drive. It can be used as a file handler to associate with file types and open them in Google Drive, or also as a command line tool to upload files to Google Drive. |
| 4 | +Guppy is a simple tool for opening files from your computer in Google Drive. It can be set as the default file handler |
| 5 | +or as a command-line tool. |
| 6 | + |
| 7 | +## Usage |
| 8 | +When you launch guppy for the first time, it will set itself as the default handler. Then you can double-click or |
| 9 | +right-click and select open with any CSV, Excel, Word, or PowerPoint file to have guppy upload and open it in Google |
| 10 | +Drive. |
| 11 | + |
| 12 | +#### Command Line |
| 13 | +`guppy [file]` `guppy upload [file]` |
| 14 | +Upload a file to Google Drive. |
| 15 | + |
| 16 | +`guppy login` |
| 17 | +Login to Google Drive. |
| 18 | + |
| 19 | +`guppy help [command]` |
| 20 | +Display help information. |
| 21 | + |
| 22 | +#### Flags |
| 23 | +``` |
| 24 | +-h, --help Provides help command |
| 25 | +-v, --verbose Enable verbose output |
| 26 | +``` |
3 | 27 |
|
4 | 28 | ## Installation |
5 | | -Create a Google OAuth2 Client ID for Desktop applications. |
6 | | -Deploy a configuration profile for macOS. |
7 | | -Download the guppy app from releases. |
| 29 | +To use guppy, you will need to set up a Google OAuth2 Client ID. As an organization, you can distribute the OAuth2 |
| 30 | +Client ID to your users via an MDM configuration profile. |
8 | 31 |
|
9 | | -## Usage |
10 | | -Set guppy as the default file handler |
11 | | -Double-click or Open with, authorize Google Drive, the authorization is saved in the keychain for 1 hour. |
| 32 | +#### Create a Google OAuth2 Client ID for Desktop applications |
| 33 | +1. Go to https://console.cloud.google.com/projectcreate |
| 34 | +2. Enable the Google Drive API |
| 35 | +3. Configure OAuth consent screen |
| 36 | +4. Create a OAuth2 Client ID for Web application, save the client ID |
| 37 | +5. Add `http://localhost/interstitial.html` as a redirect URI |
| 38 | + |
| 39 | +#### Deploy a configuration profile for macOS |
| 40 | +Examples of configuration profiles can be found in the `extras` folder. Substitute the client ID in the configuration |
| 41 | +profile with your own from Step 4 above. |
| 42 | +| key | type | required | default | |
| 43 | +|----------------------|---------|----------|---------| |
| 44 | +| GoogleOauth2ClientId | String | true | | |
| 45 | +| DisableAnalytics | Boolean | false | false | |
| 46 | + |
| 47 | +#### Download the guppy app from releases |
| 48 | +The latest release of guppy can be found in the [releases](https://github.com/forevanyeung/guppy/releases) section of |
| 49 | +this repository. |
0 commit comments