Merge pull request #36 from aaravmaloo/main

CosmicPredator · web-flow · commit dc8c9691deba · 2026-03-25T00:00:35.000+05:30
Add structured JSON output and expanded title metadata (concerns #35)
diff --git a/cmd/cmd_info.go b/cmd/cmd_info.go
@@ -10,13 +10,13 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func handleMediaInfo(_ *cobra.Command, args []string) {
+func handleMediaInfo(cmd *cobra.Command, args []string) {
 	id, err := strconv.Atoi(args[0])
 	if err != nil {
 		fmt.Println(ui.ErrorText(errors.New("invalid media id provided")))
 	}
 	
-	err = viewmodel.HandleMediaInfo(id)
+	err = viewmodel.HandleMediaInfo(id, GlobalJSON)
 	if err != nil {
 		fmt.Println(ui.ErrorText(err))
 	}
diff --git a/cmd/cmd_list.go b/cmd/cmd_list.go
@@ -12,7 +12,7 @@ var listMediaType string
 var listStatus string
 
 func handleLs(cmd *cobra.Command, args []string) {
-	err := viewmodel.HandleMediaList(listMediaType, listStatus)
+	err := viewmodel.HandleMediaList(listMediaType, listStatus, GlobalJSON)
 	if err != nil {
 		fmt.Println(ui.ErrorText(err))
 	}
diff --git a/cmd/cmd_media_search.go b/cmd/cmd_media_search.go
@@ -19,11 +19,12 @@ func handleMediaSearch(cmd *cobra.Command, args []string) {
 		os.Exit(0)
 	}
 
-	combinedQuery := strings.Join(args, "")
+	combinedQuery := strings.Join(args, " ")
 	err := viewmodel.HandleMediaSearch(
 		combinedQuery,
 		searchMediaType,
 		pageSize,
+		GlobalJSON,
 	)
 
 	if err != nil {
diff --git a/cmd/cmd_profile.go b/cmd/cmd_profile.go
@@ -9,7 +9,7 @@ import (
 )
 
 func handleProfile(cmd *cobra.Command, args []string) {
-	err := viewmodel.HandleProfile()
+	err := viewmodel.HandleProfile(GlobalJSON)
 	if err != nil {
 		fmt.Println(ui.ErrorText(err))
 	}
diff --git a/cmd/cmd_root.go b/cmd/cmd_root.go
@@ -10,6 +10,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
+var GlobalJSON bool
+
 var rootCmd = &cobra.Command{
 	Use:  "chibi",
 	Long: "Chibi for AniList - A lightweight anime & manga tracker CLI app powered by AniList.\nRead the documentation at https://chibi-cli.pages.dev/",
@@ -34,6 +36,7 @@ func Execute(version string) {
 		mediaInfoCmd,
 		themeCmd,
 	)
+	rootCmd.PersistentFlags().BoolVarP(&GlobalJSON, "json", "j", false, "Output in JSON format")
 	if err := fang.Execute(
 		context.TODO(),
 		rootCmd,
diff --git a/docs/02_cli_guide/info.md b/docs/02_cli_guide/info.md
@@ -0,0 +1,37 @@
+---
+title: Info
+lang: en-US
+---
+
+# The `info` Command
+
+The `chibi info` command provides detailed information about a specific anime or manga using its AniList ID.
+
+## Usage
+```bash
+$ chibi info [id] [flags]
+```
+
+## Flags
+
+### `-h, --help`
+Provides help information for the `chibi info` command.
+
+### `-j, --json`
+Outputs the media information in a structured JSON format. This includes IDs, titles (romaji, english, native), synonyms, scores, progress, and full descriptions.
+
+#### Example:
+```bash
+$ chibi info 21 --json
+```
+
+## Output
+By default, the command displays a formatted list of metadata, including:
+- ID and MAL ID
+- Titles (English, Romaji, Native)
+- Format (TV, Movie, Manga, etc.)
+- Average Score
+- Episode/Chapter count
+- Genres and Tags
+- Studios
+- Detailed Description
diff --git a/docs/02_cli_guide/ls.md b/docs/02_cli_guide/ls.md
@@ -63,6 +63,20 @@ chibi list --status watching --type anime
 
 This command will display a list of anime that you are currently watching.
 
+### `-j, --json`
+Outputs the list in a structured JSON format. This is particularly useful for automation scripts and programmatic data processing.
+
+The JSON output includes:
+- `id`: The AniList Media ID
+- `status`: The current status (e.g., WATCHING, COMPLETED)
+- `progress`: Your current episode or chapter progress
+- `titles`: A nested object containing `romaji`, `english`, and `native` titles
+
+#### Example:
+```bash
+$ chibi list --json
+```
+
 ## Defaults
 - The default `status` is `watching`.
 - The default `type` is `anime`.
diff --git a/docs/02_cli_guide/profile.md b/docs/02_cli_guide/profile.md
@@ -22,6 +22,24 @@ Provides help information for the `chibi profile` command. Use this flag to disp
 $ chibi profile --help
 ```
 
+### `-j, --json`
+Outputs your profile information in a structured JSON format.
+
+The JSON output includes:
+- `id`: Your AniList user ID
+- `name`: Your username
+- `totalAnime`: Your total anime count
+- `totalManga`: Your total manga count
+- `minutesWatched`: Your total minutes watched
+- `chaptersRead`: Your total chapters read
+- `avatarUrl`: The URL to your profile avatar
+- `siteUrl`: The URL to your AniList profile page
+
+#### Example:
+```bash
+$ chibi profile --json
+```
+
 ## Requirements
 This command requires you to be logged in to your AniList account. If you are not logged in, the command will prompt you to do so before retrieving your profile information.
 
diff --git a/docs/02_cli_guide/search.md b/docs/02_cli_guide/search.md
@@ -53,6 +53,18 @@ $ chibi search "Naruto" --type anime --page 3
 ```
 This command will return up to 3 anime results for the query `"Naruto"`.
 
+### `-j, --json`
+Outputs search results in a structured JSON format.
+
+The JSON output includes:
+- `id`: The AniList Media ID
+- `titles`: A nested object containing `romaji`, `english`, and `native` titles
+
+#### Example:
+```bash
+$ chibi search "One Piece" --json
+```
+
 ## Defaults
 - The default `type` is `anime`.
 - The default `page` is 10 results.
diff --git a/internal/api/queries.go b/internal/api/queries.go
@@ -6,6 +6,9 @@ const searchMediaQuery = `query($searchQuery: String, $perPage: Int, $mediaType:
             id
             title {
                 userPreferred
+                romaji
+                english
+                native
             }
 			type
             averageScore
@@ -24,6 +27,9 @@ const mediaListQuery = `query ($id: Int, $statusIn: [MediaListStatus]) {
 					id
 					title {
 						userPreferred
+						romaji
+						english
+						native
 					}
 					episodes
 					chapters
@@ -45,6 +51,9 @@ const mediaListQuery = `query ($id: Int, $statusIn: [MediaListStatus]) {
 					id
 					title {
 						userPreferred
+						romaji
+						english
+						native
 					}
 					episodes
 					chapters
@@ -85,6 +94,7 @@ const mediaInfoQuery = `query($id: Int) {
       romaji
       native
     }
+    synonyms
     meanScore
     coverImage {
       extraLarge
diff --git a/internal/api/responses/media_info.go b/internal/api/responses/media_info.go
@@ -10,6 +10,7 @@ type MediaInfo struct {
 				Romaji  string `json:"romaji"`
 				Native  string `json:"native"`
 			} `json:"title"`
+			Synonyms []string `json:"synonyms"`
 			MeanScore  int `json:"meanScore"`
 			CoverImage struct {
 				ExtraLarge string `json:"extraLarge"`
diff --git a/internal/api/responses/media_list.go b/internal/api/responses/media_list.go
@@ -10,6 +10,9 @@ type ListCollection struct {
 				Id    int `json:"id"`
 				Title struct {
 					UserPreferred string `json:"userPreferred"`
+					Romaji        string `json:"romaji"`
+					English       string `json:"english"`
+					Native        string `json:"native"`
 				} `json:"title"`
 				Chapters    *int   `json:"chapters"`
 				Volumes     *int   `json:"volumes"`
diff --git a/internal/api/responses/media_search.go b/internal/api/responses/media_search.go
@@ -4,6 +4,9 @@ type MediaSearchList struct {
 	Id    int `json:"id"`
 	Title struct {
 		UserPreferred string `json:"userPreferred"`
+		Romaji        string `json:"romaji"`
+		English       string `json:"english"`
+		Native        string `json:"native"`
 	} `json:"title"`
 	AverageScore *float64 `json:"averageScore"`
 	MediaType    string   `json:"type"`
diff --git a/internal/ui/media_info.go b/internal/ui/media_info.go
@@ -1,6 +1,7 @@
 package ui
 
 import (
+	"encoding/json"
 	"fmt"
 	"strconv"
 	"strings"
@@ -26,6 +27,8 @@ type MediaInfoUI struct {
 	Studios        string
 	Description    string
 	Format         string
+	Synonyms       []string
+	JSON           bool
 }
 
 func (m *MediaInfoUI) Render() error {
@@ -45,6 +48,10 @@ func (m *MediaInfoUI) Render() error {
 		{"Description", m.Description},
 	}
 
+	if m.JSON {
+		return m.renderJSON()
+	}
+
 	maxKeyLen := 0
 	for _, kv := range dataSlice {
 		if len(kv.Key) > maxKeyLen {
@@ -87,3 +94,51 @@ func (m *MediaInfoUI) Render() error {
 	fmt.Println(sb.String())
 	return nil
 }
+
+func (m *MediaInfoUI) renderJSON() error {
+	type Title struct {
+		Romaji  string `json:"romaji"`
+		English string `json:"english"`
+		Native  string `json:"native"`
+	}
+	type InfoEntry struct {
+		Id             int      `json:"id"`
+		MalId          int      `json:"idMal"`
+		Titles         Title    `json:"titles"`
+		Synonyms       []string `json:"synonyms"`
+		Format         string   `json:"format"`
+		Score          int      `json:"score"`
+		ChapterEpisode int      `json:"chapterEpisode"`
+		VolumeDuration int      `json:"volumeDuration"`
+		Genres         string   `json:"genres"`
+		Tags           string   `json:"tags"`
+		Studios        string   `json:"studios"`
+		Description    string   `json:"description"`
+	}
+
+	output := InfoEntry{
+		Id:    m.Id,
+		MalId: m.MalId,
+		Titles: Title{
+			Romaji:  m.RomajiTitle,
+			English: m.EnglishTitle,
+			Native:  m.NativeTitle,
+		},
+		Synonyms:       m.Synonyms,
+		Format:         m.Format,
+		Score:          m.Score,
+		ChapterEpisode: m.ChapterEpisode,
+		VolumeDuration: m.VolumeDuration,
+		Genres:         m.Genres,
+		Tags:           m.Tags,
+		Studios:        m.Studios,
+		Description:    m.Description,
+	}
+
+	jsonData, err := json.MarshalIndent(output, "", "  ")
+	if err != nil {
+		return err
+	}
+	fmt.Println(string(jsonData))
+	return nil
+}
diff --git a/internal/ui/media_list.go b/internal/ui/media_list.go
@@ -1,6 +1,7 @@
 package ui
 
 import (
+	"encoding/json"
 	"fmt"
 	"strconv"
 	"strings"
@@ -14,6 +15,7 @@ import (
 type MediaListUI struct {
 	MediaType string
 	MediaList *responses.MediaList
+	JSON      bool
 }
 
 type MediaListEntry struct {
@@ -117,7 +119,7 @@ func (l *MediaListUI) Render() error {
 				progress = fmt.Sprintf("%v/%v", entry.Progress, total)
 			}
 
-			if list.Status == "REPEATING" {
+			if !l.JSON && list.Status == "REPEATING" {
 				entry.Media.Title.UserPreferred = lipgloss.
 					NewStyle().
 					Foreground(lipgloss.Color(palette.TableRepeating)).
@@ -134,6 +136,47 @@ func (l *MediaListUI) Render() error {
 		}
 	}
 
+	if l.JSON {
+		return l.renderJSON(selectedList)
+	}
+
 	fmt.Println(l.renderColumn(internal.MediaType(l.MediaType), rows...))
 	return nil
 }
+
+func (l *MediaListUI) renderJSON(selectedList responses.ListCollection) error {
+	type Title struct {
+		Romaji  string `json:"romaji"`
+		English string `json:"english"`
+		Native  string `json:"native"`
+	}
+	type MediaEntry struct {
+		Id       int    `json:"id"`
+		Status   string `json:"status"`
+		Progress int    `json:"progress"`
+		Titles   Title  `json:"titles"`
+	}
+
+	var output []MediaEntry
+	for _, list := range selectedList.Lists {
+		for _, entry := range list.Entries {
+			output = append(output, MediaEntry{
+				Id:       entry.Media.Id,
+				Status:   list.Status,
+				Progress: entry.Progress,
+				Titles: Title{
+					Romaji:  entry.Media.Title.Romaji,
+					English: entry.Media.Title.English,
+					Native:  entry.Media.Title.Native,
+				},
+			})
+		}
+	}
+
+	jsonData, err := json.MarshalIndent(output, "", "  ")
+	if err != nil {
+		return err
+	}
+	fmt.Println(string(jsonData))
+	return nil
+}
diff --git a/internal/ui/media_search.go b/internal/ui/media_search.go
diff --git a/internal/ui/profile.go b/internal/ui/profile.go
diff --git a/internal/viewmodel/media_info_handler.go b/internal/viewmodel/media_info_handler.go
diff --git a/internal/viewmodel/media_list_handler.go b/internal/viewmodel/media_list_handler.go
diff --git a/internal/viewmodel/media_search_handler.go b/internal/viewmodel/media_search_handler.go
diff --git a/internal/viewmodel/profile_handler.go b/internal/viewmodel/profile_handler.go

Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,13 @@ import (`
`10`	`10`	`"github.com/spf13/cobra"`
`11`	`11`	`)`
`12`	`12`
`13`		`-func handleMediaInfo(_ *cobra.Command, args []string) {`
	`13`	`+func handleMediaInfo(cmd *cobra.Command, args []string) {`
`14`	`14`	`id, err := strconv.Atoi(args[0])`
`15`	`15`	`if err != nil {`
`16`	`16`	`fmt.Println(ui.ErrorText(errors.New("invalid media id provided")))`
`17`	`17`	`}`
`18`	`18`
`19`		`- err = viewmodel.HandleMediaInfo(id)`
	`19`	`+ err = viewmodel.HandleMediaInfo(id, GlobalJSON)`
`20`	`20`	`if err != nil {`
`21`	`21`	`fmt.Println(ui.ErrorText(err))`
`22`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ var listMediaType string`
`12`	`12`	`var listStatus string`
`13`	`13`
`14`	`14`	`func handleLs(cmd *cobra.Command, args []string) {`
`15`		`- err := viewmodel.HandleMediaList(listMediaType, listStatus)`
	`15`	`+ err := viewmodel.HandleMediaList(listMediaType, listStatus, GlobalJSON)`
`16`	`16`	`if err != nil {`
`17`	`17`	`fmt.Println(ui.ErrorText(err))`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,12 @@ func handleMediaSearch(cmd *cobra.Command, args []string) {`
`19`	`19`	`os.Exit(0)`
`20`	`20`	`}`
`21`	`21`
`22`		`- combinedQuery := strings.Join(args, "")`
	`22`	`+ combinedQuery := strings.Join(args, " ")`
`23`	`23`	`err := viewmodel.HandleMediaSearch(`
`24`	`24`	`combinedQuery,`
`25`	`25`	`searchMediaType,`
`26`	`26`	`pageSize,`
	`27`	`+ GlobalJSON,`
`27`	`28`	`)`
`28`	`29`
`29`	`30`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`)`
`10`	`10`
`11`	`11`	`func handleProfile(cmd *cobra.Command, args []string) {`
`12`		`- err := viewmodel.HandleProfile()`
	`12`	`+ err := viewmodel.HandleProfile(GlobalJSON)`
`13`	`13`	`if err != nil {`
`14`	`14`	`fmt.Println(ui.ErrorText(err))`
`15`	`15`	`}`