.roostats

[XD1amond]

What problem does this proposed feature solve?

Benefits

Analytics

This proposed feature can provide detailed analytics, insights, and breakdown of how users use Roo-Code in the form of aesthetic graphs, comprehensive summaries, and raw data ready to be exported to tools like Excel. This will assist users by allowing them to see how they use Roo-Code on a larger scale then the stats shown in a singular chat. The goal is to allow users to optimize cost, performance, and time with these analytics.

Traffic

The launch of .roostats can also be used as a social engagement tool for users to share their use of Roo-Code, akin to how users of streaming services such as Spotify share their “Spotify Wrapped”, which displays the user’s app experience. Spotify saw a 20% increase in U.S app downloads after the release of Spotify Wrapped, as more and more people saw friends, family, etc. sharing their year of music, personalized insights/breakdowns, and exclusive messages from their favorite artists.

Describe the proposed solution in detail

File

The premise of this feature is that when a directory/repository is interacted with by Roo-Code, it creates a file in the root that keeps track of different Roo-Code statistics (all statistics can be toggled whether or not they are tracked in settings) these consist of (but are not limited to):

• Input/output tokens
• Cost
• Actions (files/lines read, files/lines edited, commands executed, most frequent commands, etc.)
• Session count

All of the aforementioned statistics will be tracked with a myriad of identifiers, such as date/time, provider/model, modes, action, session, etc.

Dashboard

Users will be able to view their .roostats in a dashboard (located alongside the top bar that consists of New Task, Prompts, MCP, etc.). This will be comprised of filters (model, time period, action, mode), sorting (cost, time, actions), and search. Data can be displayed in the user's preferred way, if multiple forms of graphs are available to the user, there will be a dropdown to choose (for example if its cost by model, the user could choose either a pie chart or a bar graph.

Technical considerations or implementation details (optional)

Settings

I believe that this feature has enough potential to warrant its own section in settings. Within this section it will consist of the following settings:

General

• .roostats
  This settings toggles whether or not Roo-Code will create, edit, or otherwise interact with a .roostats file in any way.
• Create .roostats
  This setting, when toggled, will automatically create a .roostats file in the root of the working folder.
• Update .roostats
  This setting is different from the above, as this setting when enabled will automatically update .roostats files, but will not create them if they do not already exist in the project.

Stats

All the following will be tracked meticulously on a variety of different attributes, such as provider/model, action (for example cost will be tracked by reading files, writing files, executing commands, etc.), mode (Ask, Code, Debug, user created modes, etc.), etc.
Users will be able to toggle under the Stats subsection in roostats settings which of the following they want tracked:

• Input/Output Tokens
• Cost
• Sessions
• Actions Executed (times files were read, commands were executed, browser was scrolled, etc.)
• Lines edited

Dashboard

This will be the primary way users will view their .roostats files. It will offer a variety of ways to display statistics:

Cost

• Pie Chart or Bar Graph for cost breakdown by model, actions, or mode
• Line Graph for cost per session over time

Actions

• Pie Chart or Bar Graph for action breakdown by model, actions, or mode

Sessions

• Users could view a "Session Graph" (Synonymous to a github contribution graph) that shows their sessions over X amount of time or for year X.

Export

Users should be able to export their data in a variety of ways:

• Saving individual graphs as .png/.jpg
• Exporting .roostats or a section of it as a .csv
• Saving a "Summary" image that contains a quick recap of the user's graph (Sessions, Cost, Cost Pie Chart, etc.)

Technical

Charts

I personally advocate for using shadcn/ui (styled component library based off of recharts) for the graphs, as they provide aesthetic, customizable, charts for our dashboard. On top of that it easily integrates with the current frontend stack (react + tailwind).

Downsides/Considerations/Misc

• Users may edit values manually for social status (Back to the Spotify analogy, it would be like if a user changed their minutes listened from 60,000 to 100000)
• An additional feature I conceived would be "Gamification". For example achievements for tokens or money spent, however due to the above point it could easily be cheated.

Describe alternatives considered (if any)

Local Storage Vs. Project Storage

The only other alternative I have been able to conceive would be storing the .roostats file locally whether then in the project directory (similar to how Roo-Code chats are stored on the user's computer). This may be beneficial for providing overall summaries of use whether then project by project summaries, however if the user is using Roo-Code on multiple computers, as far as I am aware this would not transfer over. This is why I believe that the proposed solution is better, however a mix between the 2 may work better (users can toggle if they want it stored on their computer or in their projects).

Additional Context & Mockups

No response

Proposal Checklist

• I have searched existing Issues and Discussions to ensure this proposal is not a duplicate.
• This proposal is for a specific, actionable change intended for implementation (not a general idea).
• I understand that this proposal requires review and approval before any development work begins.

Are you interested in implementing this feature if approved?

• Yes, I would like to contribute to implementing this feature.

[hannesrudolph]

Very thorough @XD1amond. Would you be able to review this on Monday with the PRs? @mrubens

[dlab-anton]

I did some preliminary work in this area a bit ago (paused while data collection details were being sorted for per-task and aggregate stats), and had a few thoughts that might be relevant:

• Strongly suggest starting with user stories to define the problems users are trying to solve with the data rather than just displaying what is available. This will make sure whatever is being displayed will be useful / beneficial.
• uPlot much faster / smaller package
• storage stats in a file during task and then dashboard displays aggregate
• Recommend bar charts over pie charts for clarity in interpretation
• Totally agree that transparent stats are on-brand + the enhanced shareability will improve viral coefficient.

[XD1amond]

Thank you for the advice and feedback @dlab-anton, It is much appreciated. I agree with this completely except for point #1. While I don't believe in swarming users with unnecessary data, I don't like the idea of holding stats/data back from users. I want a good balance/options between the two, which is why I propose the concept at the end of this comment. Also do you think that uPlot will fit with the Roo-Code style well enough? I haven't worked with it before so I may be mistaken, but from what I can tell the elements are unable to be styled.

@hannesrudolph Have you thought of an "Advanced Mode" setting toggle before? It's a concept I introduced into one of my other projects, a cognitive training platform, that has many different settings. I felt as though the wide variety of options would be overwhelming for new users, so I added a toggle that hides certain settings (hidden by default) that aren't necessarily needed when starting out. I feel as though a similar feature would be beneficial in Roo-Code especially if part of the target audience is the newer "Vibe Coders"; non-tech/software people who are trying to make their dreams/ideas come to life via code. This would warrant a separate issue if you find it useful enough, however I am proposing the idea here as I think that if "Advanced Mode" is enabled, it should give users the option to choose the way their data is displayed (bar chat vs pie chart) and what data is displayed (Advanced Mode off would display targeted/useful data, Advanced Mode on would display all available data (able to be customized what is shown))

[dlab-anton]

@XD1amond you can see a basic implementation of uplot: #3063
styling is no issue imo.

Regardless of whether to show all data or not, it will always be a decision of what to show first, where to show it, how to show it. All these decisions can start from the user story.

bar chat vs pie chart

pie charts get endless hate from data viz for a good reason - comparing area of slice much harder than bar on a straight axis