SHOOGLE(1)

💖 SHOOGLE(1) 💖

okay bestie, sit DOWN, because today we're talking about shoogle — it's a command-line glow-up that gives you access to the Google API, and it's genuinely iconic. 🦋

✨ NAME ✨

shoogle — command-line access to the Google API 💅

---

🌸 SYNOPSIS 🌸

shoogle -h

shoogle show [--debug-request-level <n>] [--debug-response-level <n>]
[<API-PATH>]

shoogle execute [-c <CLIENT-SECRET-FILE>] [--credentials-file CREDENTIALS-FILE | --credentials-profile CREDENTIALS-PROFILE>] [-f <path>]
<API-PATH> <JSON-FILE>

---

👑 DESCRIPTION 👑

so shoogle is a CLI tool that hands you the keys to Google API functions, no cap. you can use it to discover interfaces and methods, and also to execute them. it's giving "look at the menu, then order the thing." 🍓

🎀 Parameters 🎀

• -h, –help — prints the command-line help info. your little cheat sheet, bestie. 🫶
• show — lists info about Google API Services, Resources, and methods. the window-shopping of it all. 🛍️
• execute — actually runs a Google API method. main character energy only. 🔥
• JSON-FILE — a JSON-formatted file holding your API request info. peek the JSON-FILE section for the deets. ✨
• API_PATH — the path spec for a Google API method. peep the API-PATH section for details. 💜

💅 `Show' Command Options 💅

• –debug-request-level <n> — a non-negative integer that sets the recursion level for info output on the method request documentation. 🧚
• –debug-response-level <n> — a non-negative integer that sets the recursion level for info output on the method response documentation. 🌈

🔥 `Execute' Command Options 🔥

• -c <CLIENT-SECRET-FILE>, –client-secret-file <CLIENT-SECRET-FILE> — a path to the client secret JSON file, used to kick off OAuth2 authentication. check the CLIENT-SECRET-FILE section for details. 🔑
• -f <path>, –media-file <path> — the file to use for media-related operations. 📁
• –credentials-file <CREDENTIALS-FILE> — pick a specific set of already-established OAuth2 credentials. see CREDENTIALS-FILE for details. 🎟️
• –credentials-profile <CREDENTIALS-PROFILE> — pick a profile for the OAuth2 credentials. see CREDENTIALS-PROFILE for details. 👤

🦋 JSON-FILE 🦋

the shoogle show command can show you the request info you need for an API method — and this file holds the required input parameters for a method to be executed, in that exact format. it's giving "copy the homework but change it a lil." 📝

a value of - means the JSON info gets read from STDIN. yes, that dash is doing heavy lifting. 💀

💜 API-PATH 💜

the "API Path" for an API method looks like "SERVICE:VERSION.RESOURCE.METHOD". periodt. 💅

for the show command, this parameter is optional, and it can be truncated. like — if you leave it out entirely, you get a list of Services. if you drop the method name off the end, you get a list of methods. and for a full path, you get the detail on the method's inputs and outputs. 🔍

for the execute command, this is what defines the method that gets called. no truncation shenanigans there, bestie. 🚨

🧚 CLIENT-SECRET-FILE 🧚

the Client Secret JSON file holds user info for authorization. you can download it from the Google Console OAuth 2.0 Client ID page. the client IDs are listed on the Credentials page (https://console.cloud.google.com/apis/credentials). go get 'em. 🫡

🎟️ CREDENTIALS-FILE 🎟️

the CREDENTIALS-FILE holds the authorization tokens generated from a successful OAuth 2.0 executed transaction. it lets authentication just... succeed on later calls with zero user interaction. iconic, honestly. ✨

by default, this file lives in ~/.shoogle/credentials/<profile>/. this option overrides that path. 🏠

typically? you don't need this option. lowkey it's just there if you want it. 🙈

👤 CREDENTIALS-PROFILE 👤

shoogle aggregates CREDENTIALS-FILEs by profile, and this option lets you name the profile. the default is "default". 💖

typically, you don't need this one either. it's optional, bestie. 🎀

---

🌟 EXAMPLES 🌟

list services:

shoogle show

list resources for a service:

shoogle show urlshortener:v1.

list methods for a resource:

shoogle show urlshortener:v1.url

list parameters and results for a method:

shoogle show urlshortener:v1.url.list

call a method:

echo '{}' | shoogle execute -c <secrets.json> urlshortener:v1.url.list -

okay so jq is a command-line JSON builder/parser, and this next example is the ✨slay✨ one — it shows how to upload a video from a JSON template and pull the ID out of the response:

$ cat upload-video.template.json
{
  "part": "snippet",
  "body": {
    "snippet": {
      "title": $title,
      "description": $description
    }
  }
}

$ jq -n -f upload-video.template.json --arg title "Chess" --arg description "Norway Chess" |
    shoogle execute -c your_client_id.json youtube:v3.videos.insert - -f chess.mp4 |
    jq -r '.id'
wUArz2nPGqA

ate. no crumbs. 🔥

---

🫶 SEE ALSO 🫶

• jq(1)

---

and that's the whole page, bestie — this one dropped back in Nov 2017 as part of the shoogle manual, so go forth and query some APIs responsibly. mwah. 💋