Skip to content

Commit 752a893

Browse files
committed
docs: usage instructions
1 parent 9ac4788 commit 752a893

File tree

2 files changed

+78
-8
lines changed

2 files changed

+78
-8
lines changed

README.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,49 @@
1+
![](extras/art/guppy-1.png)
2+
13
# 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+
```
327

428
## 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.
831

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.

extras/guppy.mobileconfig

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,18 @@
55
<key>PayloadContent</key>
66
<array>
77
<dict>
8+
<key>PayloadDisplayName</key>
9+
<string>Custom Settings</string>
10+
<key>PayloadIdentifier</key>
11+
<string>79663069-1865-4C0B-9C2F-72977D4C5C79</string>
12+
<key>PayloadOrganization</key>
13+
<string></string>
14+
<key>PayloadType</key>
15+
<string>com.apple.ManagedClient.preferences</string>
16+
<key>PayloadUUID</key>
17+
<string>79663069-1865-4C0B-9C2F-72977D4C5C79</string>
18+
<key>PayloadVersion</key>
19+
<integer>1</integer>
820
<key>PayloadContent</key>
921
<dict>
1022
<key>com.forevanyeung.guppy</key>
@@ -15,7 +27,7 @@
1527
<key>mcx_preference_settings</key>
1628
<dict>
1729
<key>GoogleOauth2ClientId</key>
18-
<string></string>
30+
<string>xxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com</string>
1931
<key>DisableAnalytics</key>
2032
<false />
2133
</dict>
@@ -25,5 +37,25 @@
2537
</dict>
2638
</dict>
2739
</array>
40+
<key>PayloadUUID</key>
41+
<string>F3800699-4456-4B39-837F-8BBBBA8306BF</string>
42+
<key>PayloadType</key>
43+
<string>Configuration</string>
44+
<key>PayloadOrganization</key>
45+
<string></string>
46+
<key>PayloadIdentifier</key>
47+
<string>F3800699-4456-4B39-837F-8BBBBA8306BF</string>
48+
<key>PayloadDisplayName</key>
49+
<string>Guppy Configuration</string>
50+
<key>PayloadDescription</key>
51+
<string />
52+
<key>PayloadVersion</key>
53+
<integer>1</integer>
54+
<key>PayloadEnabled</key>
55+
<true />
56+
<key>PayloadRemovalDisallowed</key>
57+
<false />
58+
<key>PayloadScope</key>
59+
<string>User</string>
2860
</dict>
2961
</plist>

0 commit comments

Comments
 (0)