add '--all' flag to display hidden fields

Author: adamhl8

README.md

@@ -24,7 +24,7 @@ A CLI tool for querying and inspecting the media in your Radarr and Sonarr insta
 
 <!-- tocstop -->
 
-If you're looking for a tool to manage/change your \*arrs, check out [managarr](https://github.com/Dark-Alex-17/managarr).
+If you're looking for a more general tool to manage/change your \*arrs, check out [managarr](https://github.com/Dark-Alex-17/managarr).
 
 ## Installation
 
@@ -127,6 +127,21 @@ inspectarr radarr 'monitored && videoCodec *= 265'
 - `season` (alias: `s`) - Season number
 - `episode` (alias: `e`) - Episode number
 
+#### Hidden Fields
+
+Some fields are hidden by default to prevent the markdown output from being too wide. Note: The JSON output will always include all fields.
+
+To display hidden fields, use the `--all` flag.
+
+- `qualityProfile` (alias: `qp`) - Quality profile name
+- `rawResolution` - Total pixel count
+- `rawSize` - File size in bytes
+
+> [!TIP]
+> If the markdown output is too wide, use the `EXCLUDE` operation to exclude specific fields/columns.
+>
+> For example: `inspectarr sonarr --all '* | EXCLUDE rawResolution rawSize'`
+
 #### Operations
 
 In addition to the [built-in FilterQL operations](https://github.com/adamhl8/filterql#operations), the following operations are available:
@@ -148,10 +163,11 @@ inspectarr radarr 'source == bluray | EXCLUDE resolution size'
 - `--output <md|json>`: The type of output to generate ("json" implies --quiet) (default: "md")
 - `--quiet`: Suppress all output except the markdown/JSON
 - `--short-headers`: Use the field aliases as the markdown table headers (can help reduce the width of the table)
+- `--all`: Show fields that are hidden by default in the markdown table
 
 **Sonarr-specific flags:**
 
 By default, media from Sonarr is displayed by series.
 
-- `--by-season`: Display media by individual season
 - `--by-episode`: Display media by individual episode
+- `--by-season`: Display media by individual season

bun.lock

@@ -1,6 +1,6 @@
 {
   "name": "inspectarr",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "type": "module",
   "description": "A CLI tool for querying and inspecting the media in your Radarr and Sonarr instances",
   "repository": {
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "cleye": "^1.3.4",
-    "filterql": "^3.0.0",
+    "filterql": "^3.0.1",
     "ky": "^1.9.1",
     "tablemark": "github:haltcase/tablemark#v4",
     "ts-explicit-errors": "^3.0.0"

package.json

@@ -7,6 +7,7 @@ import type { paths } from "~/generated/radarr-schema.ts"
 import { formatSize, getRawResolution } from "~/utils.ts"
 
 type RadarrAllMedia = paths["/api/v3/movie"]["get"]["responses"]["200"]["content"]["application/json"][number]
+type RadarrQualityProfiles = paths["/api/v3/qualityprofile"]["get"]["responses"]["200"]["content"]["application/json"]
 
 export class RadarrClient extends ArrClient {
   public constructor(baseUrl: string, apiKey: string) {
@@ -17,10 +18,17 @@ export class RadarrClient extends ArrClient {
     return this.makeRequest<RadarrAllMedia[]>("movie")
   }
 
+  public getAllQualityProfiles(): Promise<Result<RadarrQualityProfiles>> {
+    return this.makeRequest<RadarrQualityProfiles>("qualityprofile")
+  }
+
   public async getMediaData() {
     const allMedia = await this.getAllMedia()
     if (isErr(allMedia)) return err("failed to get radarr media", allMedia)
 
+    const qualityProfiles = await this.getAllQualityProfiles()
+    if (isErr(qualityProfiles)) return err("failed to get radarr quality profiles", qualityProfiles)
+
     const data: RadarrMediaData = []
     for (const movie of allMedia) {
       if (!movie.hasFile) continue
@@ -34,6 +42,7 @@ export class RadarrClient extends ArrClient {
         monitored: movie.monitored,
         releaseGroup: movieFile?.releaseGroup,
         source: movieFile?.quality?.quality?.source,
+        qualityProfile: qualityProfiles.find((profile) => profile.id === movie.qualityProfileId)?.name,
         videoCodec: mediaDetails?.videoCodec,
         audioCodec: mediaDetails?.audioCodec,
         audioChannels: mediaDetails?.audioChannels,

src/arr-client/radarr-client.ts

@@ -8,6 +8,7 @@ import { formatSize, getRawResolution } from "~/utils.ts"
 
 type SonarrAllMedia = paths["/api/v3/series"]["get"]["responses"]["200"]["content"]["application/json"]
 type SonarrSeries = SonarrAllMedia[number]
+type SonarrQualityProfiles = paths["/api/v3/qualityprofile"]["get"]["responses"]["200"]["content"]["application/json"]
 
 type SeriesEpisodes = paths["/api/v3/episode"]["get"]["responses"]["200"]["content"]["application/json"]
 type SeriesEpisode = SeriesEpisodes[number] | undefined
@@ -38,6 +39,8 @@ type SeriesBySeason = { series: SonarrSeries; seasons: SeasonsArray }
 
 const seriesTitle = (series: SonarrSeries) => series.title
 const seriesYear = (series: SonarrSeries) => series.year
+const seriesQualityProfile = (series: SonarrSeries, qualityProfiles: SonarrQualityProfiles) =>
+  qualityProfiles.find((profile) => profile.id === series.qualityProfileId)?.name
 const seasonIdentifier = (seasonNumber: number) => seasonNumber.toString().padStart(2, "0")
 const episodeIdentifier = (episode?: SeriesEpisode) => episode?.episodeNumber?.toString().padStart(2, "0")
 const seriesType = (series: SonarrSeries) => series.seriesType
@@ -84,6 +87,10 @@ export class SonarrClient extends ArrClient {
     return await this.makeRequest<SonarrAllMedia>("series")
   }
 
+  public getAllQualityProfiles(): Promise<Result<SonarrQualityProfiles>> {
+    return this.makeRequest<SonarrQualityProfiles>("qualityprofile")
+  }
+
   private async getAllEpisodesForSeries(series: SonarrSeries): Promise<Result<SeriesEpisodes>> {
     if (!series.id) return err(`series id is missing for series '${series.title}'`)
     const episodes = await this.makeRequest<SeriesEpisodes>(`episode?seriesId=${series.id}&includeEpisodeFile=true`)
@@ -144,6 +151,9 @@ export class SonarrClient extends ArrClient {
     const allSeriesBySeason = await this.getAllSeriesBySeason()
     if (isErr(allSeriesBySeason)) return allSeriesBySeason
 
+    const qualityProfiles = await this.getAllQualityProfiles()
+    if (isErr(qualityProfiles)) return err("failed to get sonarr quality profiles", qualityProfiles)
+
     const data: SonarrMediaData = []
 
     if (this.#options.byEpisode) {
@@ -159,6 +169,7 @@ export class SonarrClient extends ArrClient {
               episode: episodeIdentifier(episode),
               type: seriesType(series),
               monitored: episode?.monitored,
+              qualityProfile: seriesQualityProfile(series, qualityProfiles),
               releaseGroup: episodeReleaseGroup(episode),
               source: episodeSource(episode),
               videoCodec: episodeVideoCodec(episode),
@@ -182,6 +193,7 @@ export class SonarrClient extends ArrClient {
             season: seasonIdentifier(seasonNumber),
             type: seriesType(series),
             monitored: series.seasons?.find((seasonElement) => seasonElement.seasonNumber === seasonNumber)?.monitored,
+            qualityProfile: seriesQualityProfile(series, qualityProfiles),
             releaseGroup: gatherEpisodeData([season], episodeReleaseGroup),
             source: gatherEpisodeData([season], episodeSource),
             videoCodec: gatherEpisodeData([season], episodeVideoCodec),
@@ -202,6 +214,7 @@ export class SonarrClient extends ArrClient {
           year: seriesYear(series),
           type: seriesType(series),
           monitored: series.monitored,
+          qualityProfile: seriesQualityProfile(series, qualityProfiles),
           releaseGroup: gatherEpisodeData(seasons, episodeReleaseGroup),
           source: gatherEpisodeData(seasons, episodeSource),
           videoCodec: gatherEpisodeData(seasons, episodeVideoCodec),

src/arr-client/sonarr-client.ts

@@ -63,10 +63,10 @@ export function getServiceInfo(): CommandInfo {
   const filterql = new FilterQL({ schema, customOperations })
   const query = Object.hasOwn(args._, "query") ? (args._.query ?? "") : ""
 
-  let { output, quiet, shortHeaders } = args.flags
+  let { output, quiet, shortHeaders, all } = args.flags
   const outputResult = handleFlagResult(output, showHelpAndExit)
   if (outputResult === "json") quiet = true
-  const logger = new Logger({ output: outputResult, quiet, shortHeaders }, schema)
+  const logger = new Logger({ output: outputResult, quiet, shortHeaders, all }, schema)
 
   return {
     client,

src/cli/cli.ts

@@ -42,6 +42,11 @@ const outputFlags = {
     description: "Use the field aliases as the markdown table headers (can help reduce the width of the table)",
     default: false,
   },
+  all: {
+    type: Boolean,
+    description: "Show fields that are hidden by default in the markdown table",
+    default: false,
+  },
 } as const satisfies Flags
 export type OutputFlags = FlagsToType<typeof outputFlags>
 
@@ -56,6 +61,7 @@ export const baseParameters = ["[query]"] as const satisfies CliParameters
  * These are extra fields we want to attach to the data, but don't want to be displayed in the markdown output at all
  */
 const hiddenFields = {
+  qualityProfile: { type: "string", alias: "qp" },
   rawResolution: { type: "number" },
   rawSize: { type: "number" },
 } as const satisfies Schema

src/cli/shared.ts

@@ -6,15 +6,15 @@ import { baseFlags, baseParameters, baseSchema } from "~/cli/shared.ts"
 import type { Flags, FlagsToType, SchemaToType, ToMediaData } from "~/cli/types.ts"
 
 const sonarrOptionFlags = {
-  bySeason: {
+  byEpisode: {
     type: Boolean,
     default: false,
-    description: "Display media by individual season",
+    description: "Display media by individual episode",
   },
-  byEpisode: {
+  bySeason: {
     type: Boolean,
     default: false,
-    description: "Display media by individual episode",
+    description: "Display media by individual season",
   },
 } as const satisfies Flags
 export type SonarrOptions = FlagsToType<typeof sonarrOptionFlags>

src/cli/sonarr.ts

@@ -20,19 +20,29 @@ async function inspectarr(): Promise<Result> {
   const mediaData = await client.getNormalizedMediaData()
   if (isErr(mediaData)) return mediaData
 
-  const filteredMedia = attempt(() => filterql.query(mediaData, query))
+  const ast = attempt(() => filterql.parse(query))
+  if (isErr(ast)) return err(`failed to parse query '${query}'`, ast)
+
+  const filteredMedia = attempt(() => filterql.applyFilter(mediaData, ast.filter))
   if (isErr(filteredMedia)) return err(`failed to filter media with query '${query}'`, filteredMedia)
 
+  // don't apply EXCLUDE operation if output is JSON
+  const operations =
+    logger.options.output === "json" ? ast.operations.filter(({ name }) => name !== "EXCLUDE") : ast.operations
+
+  const transformedMedia = attempt(() => filterql.applyOperations(filteredMedia, operations))
+  if (isErr(transformedMedia)) return err(`failed to apply operations to media with query '${query}'`, transformedMedia)
+
   if (!process.env["IS_VHS_DEMO"]) {
     logger.info(`${client.name} has: ${getStats(mediaData)}`)
     // only display query stats if they're actually different
-    if (mediaData.length !== filteredMedia.length) logger.info(`The query matched: ${getStats(filteredMedia)}`)
+    if (mediaData.length !== transformedMedia.length) logger.info(`The query matched: ${getStats(transformedMedia)}`)
   }
 
-  if (filteredMedia.length === 0) return
+  if (transformedMedia.length === 0) return
 
   logger.info("")
-  logger.printMediaData(filteredMedia)
+  logger.printMediaData(transformedMedia)
 }
 
 async function main(): Promise<number> {

src/index.ts

@@ -5,26 +5,26 @@ import { tablemark } from "tablemark"
 
 import type { OutputFlags } from "~/cli/shared.ts"
 import { hiddenFieldKeys, mergedFieldKeys } from "~/cli/shared.ts"
-import type { JsonifiableMediaData } from "~/cli/types.ts"
+import type { AllMediaDataKeys, JsonifiableMediaData } from "~/cli/types.ts"
 import { formatQualifiedValue, omit } from "~/utils.ts"
 
 const pipeRegex = /\|/g
 
 export class Logger {
-  readonly #options: OutputFlags
+  public readonly options: OutputFlags
   readonly #schema: Schema
 
   public constructor(options: OutputFlags, schema: Schema) {
-    this.#options = options
+    this.options = options
     this.#schema = schema
   }
 
   public info(message: string): void {
-    if (!this.#options.quiet) console.info(message)
+    if (!this.options.quiet) console.info(message)
   }
 
   public printMediaData(data: JsonifiableMediaData) {
-    const output = this.#options.output === "md" ? this.toMarkdown(data) : this.toJson(data)
+    const output = this.options.output === "md" ? this.toMarkdown(data) : this.toJson(data)
     process.stdout.write(output)
   }
 
@@ -37,7 +37,7 @@ export class Logger {
         return value.toString().replaceAll(pipeRegex, "\\|") // need to escape any pipe characters
       },
     }
-    if (this.#options.shortHeaders)
+    if (this.options.shortHeaders)
       tablemarkOptions.toHeaderTitle = ({ key, title }) => this.#schema[key]?.alias ?? title.toLowerCase()
 
     const markdownData = data.map((dataObject) => {
@@ -49,7 +49,10 @@ export class Logger {
           newDataObject.audioCodec = formatQualifiedValue(newDataObject.audioCodec, newDataObject.audioChannels)
       }
 
-      return omit(newDataObject, [...hiddenFieldKeys, ...mergedFieldKeys])
+      const fieldsToOmit: AllMediaDataKeys[] = [...mergedFieldKeys]
+      if (!this.options.all) fieldsToOmit.push(...hiddenFieldKeys)
+
+      return omit(newDataObject, fieldsToOmit)
     })
 
     return tablemark(markdownData, tablemarkOptions)