Skip to content

Commit

Permalink
update google-drive-cli
Browse files Browse the repository at this point in the history
  • Loading branch information
quangvinh2080 committed Aug 27, 2022
1 parent 661f1b4 commit 0213908
Show file tree
Hide file tree
Showing 51 changed files with 1,579 additions and 1,927 deletions.
32 changes: 0 additions & 32 deletions .github/workflows/cleanup.yml

This file was deleted.

47 changes: 0 additions & 47 deletions .github/workflows/test-and-release.yml

This file was deleted.

38 changes: 0 additions & 38 deletions .github/workflows/test.yml

This file was deleted.

46 changes: 25 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# google-sheet-cli
# google-drive-cli

A simple helper cli to interact with google sheets.
A simple helper cli to interact with google drive.

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/google-sheet-cli.svg)](https://npmjs.org/package/google-sheet-cli)
[![Downloads/week](https://img.shields.io/npm/dw/google-sheet-cli.svg)](https://npmjs.org/package/google-sheet-cli)
[![License](https://img.shields.io/npm/l/google-sheet-cli.svg)](https://github.com/jroehl/google-sheet-cli/blob/master/package.json)
[![Version](https://img.shields.io/npm/v/@quangvinh2080/google-drive-cli.svg)](https://npmjs.org/package/@quangvinh2080/google-drive-cli)
[![Downloads/week](https://img.shields.io/npm/dw/@quangvinh2080/google-drive-cli.svg)](https://npmjs.org/package/@quangvinh2080/google-drive-cli)
[![License](https://img.shields.io/npm/l/@quangvinh2080/google-drive-cli.svg)](https://github.com/quangvinh2080/google-drive-cli/blob/master/package.json)

[![CodeQL](https://github.com/jroehl/google-sheet-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/jroehl/google-sheet-cli/actions/workflows/codeql-analysis.yml)
[![Test version](https://github.com/jroehl/google-sheet-cli/actions/workflows/test.yml/badge.svg)](https://github.com/jroehl/google-sheet-cli/actions/workflows/test.yml)
[![CodeQL](https://github.com/quangvinh2080/google-drive-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/quangvinh2080/google-drive-cli/actions/workflows/codeql-analysis.yml)
[![Test version](https://github.com/quangvinh2080/google-drive-cli/actions/workflows/test.yml/badge.svg)](https://github.com/quangvinh2080/google-drive-cli/actions/workflows/test.yml)

- [google-sheet-cli](#google-sheet-cli)
- [google-drive-cli](#google-drive-cli)
- [Usage as CLI](#usage-as-cli)
- [Usage as library](#usage-as-library)
- [Command Topics](#command-topics)
Expand All @@ -24,38 +24,42 @@ A simple helper cli to interact with google sheets.
## Usage as CLI
<!-- usage -->
```sh-session
$ npm install -g google-sheet-cli
$ google-sheet COMMAND
$ npm install -g @quangvinh2080/google-drive-cli
$ google-drive COMMAND
running command...
$ google-sheet (-v|--version|version)
google-sheet-cli/0.0.0 darwin-x64 node-v14.15.5
$ google-sheet --help [COMMAND]
$ google-drive (-v|--version|version)
@quangvinh2080/google-drive-cli/0.0.3 linux-x64 node-v8.17.0
$ google-drive --help [COMMAND]
USAGE
$ google-sheet COMMAND
$ google-drive COMMAND
...
```
<!-- usagestop -->

If you don't want to input email and private key on every command, export it as environment variables:

```
export [email protected]
export GDRIVE_PRIVATE_KEY="service account's private key"
```

## Usage as library

You can import the GoogleSheet class as a module and use it without the cli functionality.
_See code: [src/lib/google-sheet.ts](https://github.com/jroehl/google-sheet-cli/blob/master/src/lib/google-sheet.ts)_
You can import the GoogleDrive class as a module and use it without the cli functionality.
_See code: [src/lib/google-drive.ts](https://github.com/quangvinh2080/google-drive-cli/blob/master/src/lib/google-drive.ts)_

<!-- commands -->
# Command Topics

* [`google-sheet data`](docs/data.md) - Manage data in worksheet
* [`google-sheet help`](docs/help.md) - display help for google-sheet
* [`google-sheet spreadsheet`](docs/spreadsheet.md) - Manage spreadsheets
* [`google-sheet worksheet`](docs/worksheet.md) - Manage worksheets
* [`google-drive help`](docs/help.md) - display help for google-drive

<!-- commandsstop -->

# Info

## Build with

- [googleapis](https://github.com/googleapis/googleapis) - The node module used for manipulating the google sheet
- [googleapis](https://github.com/googleapis/googleapis) - The node module used for manipulating the google drive
- [oclif](https://oclif.io) - The node module used to create the cli
- [semantic-release](https://github.com/semantic-release/semantic-release) - for releasing new versions
- [typescript](https://www.typescriptlang.org)
Expand Down
10 changes: 0 additions & 10 deletions bin/clear-testsheet.sh

This file was deleted.

28 changes: 28 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
`google-drive about`
====================

About your drive

* [`google-drive about:get`](#google-drive-aboutget)

## `google-drive about:get`

Gets information about the user, the user's Drive, and system capabilities

```
USAGE
$ google-drive about:get
OPTIONS
-h, --help show CLI help
-r, --rawOutput Get the raw output as a JSON string
--fields=fields [default: *] The paths of the fields you want included in the response. For development you can use
the special value * to return all fields, but you'll achieve greater performance by only selecting
the fields you need. For more information
EXAMPLE
$ gdrive about:get'
```

_See code: [src/commands/about/get.ts](https://github.com/quangvinh2080/google-drive-cli/blob/v0.0.3/src/commands/about/get.ts)_
102 changes: 0 additions & 102 deletions docs/data.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/drives.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
`google-drive drives`
=====================

Manage drives

* [`google-drive drives:list`](#google-drive-driveslist)

## `google-drive drives:list`

Lists the user's shared drives

```
USAGE
$ google-drive drives:list
OPTIONS
-h, --help show CLI help
-r, --rawOutput Get the raw output as a JSON string
--pageSize=pageSize [default: 10] Maximum number of shared drives to return per page. Acceptable values are 1 to
100, inclusive. (Default: 10)
--pageToken=pageToken Page token for shared drives
--q=q Query string for searching shared drives. See the "Search for shared drives" guide for
supported syntax
--useDomainAdminAccess Issue the request as a domain administrator; if set to true, then all shared drives of the
domain in which the requester is an administrator are returned. (Default: false)
EXAMPLE
$ gdrive drives:list
```

_See code: [src/commands/drives/list.ts](https://github.com/quangvinh2080/google-drive-cli/blob/v0.0.3/src/commands/drives/list.ts)_
Loading

0 comments on commit 0213908

Please sign in to comment.