Repository navigation
[GOOD FIRST ISSUE] Add progress indicators during code indexing process #1242
Description
What Needs to Be Done
Improve the user experience of the CLI by displaying progress indicators while the codebase is being indexed.
The progress output could include:
- Number of files processed.
- Current directory/module being indexed.
- Total indexing completion percentage (if feasible).
- A success message once indexing is complete.
Why This Matters
For large repositories, indexing can take some time. Without visible feedback, users may assume that the process has stalled or failed.
Providing progress indicators will:
- Improve transparency.
- Enhance the CLI experience.
- Help users estimate the remaining indexing time.
This issue is suitable for first-time contributors because it focuses on improving usability without requiring deep knowledge of the graph database implementation.
Files to Look At
- CLI-related source files responsible for initiating indexing.
- Modules handling file traversal and indexing workflows.
- Existing logging or console output utilities.
Acceptance Criteria
- Users can see progress updates during indexing.
- Progress information updates without cluttering the terminal output.
- The final output clearly indicates whether indexing succeeded or failed.
- Existing indexing functionality remains unaffected.
Tech Context
Potential approaches:
- Use simple console logs.
- Use a terminal progress library already present in the project.
- Ensure compatibility across common terminal environments.
Contributors should review the indexing pipeline to identify appropriate points for progress updates.
Mentorship
Comment on this issue if you'd like to work on it. Maintainers can help identify the relevant files and explain the indexing flow.
Activity
github-actions commentedon Jun 14, 2026
Hi! 👋 Join our CodeGraphContext Discord channel to collaborate: https://discord.gg/dR4QY32uYQ
bhavyasree-22 commentedon Jun 14, 2026
/assign
DevyanshiBansal commentedon Jun 14, 2026
Hi @bhavyasree-22 ,
I would love to be assigned to this issue! Improving the CLI user experience with clean, real-time progress visualization is a fantastic upgrade, especially for managing large codebases where indexing can feel like a black box.
My Proposed Technical Workflow:
Pipeline Reconnaissance: Locate the entry points handling asynchronous file system traversal and graph indexing loops to map where the file count and path metadata are handled.
Library Assessment: Check the dependencies for any pre-existing CLI terminal UI libraries (like ora or cli-progress). If none are present, I will construct a lightweight, native terminal carriage-return pattern (process.stdout.write('\r...') or equivalent depending on the language) to dynamically overwrite the active line and avoid flooding the terminal scrollback history.
State Hooking: Inject non-intrusive counting metrics into the stream pipeline to tracking the current module directory path, current batch index size, and an estimated total completion percentage.
Boundary Exit Mapping: Hook into the final execution resolution to print an explicit, clean terminal exit status (e.g., a green check success confirmation or a safe error logging stack trace) keeping existing indexing behavior fully intact.
My terminal environment is spun up and ready to begin. Please assign this issue to me!
Best regards,
Devyanshi
Sakshiibisht commentedon Jun 14, 2026
Hello @bhavyasree-22 👋
I would like to work on this issue under GSSoC 2026.
I have gone through the issue description and understand the goal of improving the CLI experience by providing meaningful progress updates during the indexing process. I am interested in exploring the indexing workflow and implementing user-friendly progress indicators while ensuring that the existing functionality remains unaffected.
Could you please assign this issue to me? I would appreciate any guidance regarding the relevant files or indexing flow if needed.
Thank you!
Shashankss1205 commentedon Jul 31, 2026
cgc index has had a rich live progress display for a while now (spinner, per-file progress, ETA), and #1219 — merged today — improved it further with automatic CI/non-TTY detection and a --no-progress flag. Closing as completed; thanks for the suggestion!