FAQ
Common questions.
How Codefield works, what its views mean, and what stays on your machine.
General & privacy
Does my source code leave my computer?
Your source code is analyzed locally. Codefield does not require uploading your repository to a cloud analysis service. On Windows and Linux, source text stays in the local process and the browser receives graph data. On macOS, analysis runs inside the app. Git cloning and external links can use the network.
Does Codefield run code from the repository?
No. Source and configuration files are read as text. Codefield never runs scripts or builds the project. The branch shown next to the repository name is read from files in .git, not by running Git commands.
Do I need GitHub or even a Git repository?
No. Codefield opens any local folder containing supported source files. Git is only needed when you want to clone a repository. GitHub, GitLab, Bitbucket and self-hosted Git repositories can all be used through your existing Git setup.
Can I analyze private repositories?
Yes. Open a repository already on your machine, or clone one using your existing Git authentication. Codefield never asks for your password or access token.
Do I need to commit or push before Codefield sees changes?
No. Codefield analyzes the current working tree: files as they are on disk, committed or not. Use Analyze Again after edits, pulls or branch changes.
Does Codefield watch files automatically?
Not currently. Analyze Again reads the folder again and refreshes new, changed and deleted files. You do not need to rebuild Codefield after changing your project.
Graph & Structure
What do Graph and Structure show?
Graph shows how files depend on each other. Structure is a spatial hierarchy: the current directory is in focus, with its parent, neighboring directories, subdirectories and files around it. Drill down or follow the breadcrumb back. Both views share selection, search, filters and the inspector.
Which languages are supported?
TypeScript, JavaScript, Python, Rust, Java, C, C++, PHP, Ruby, Dart, Elixir, Lua use strong resolution. Go, Kotlin, C#, Scala, Swift use conservative resolution, so graphs can be sparser. Codefield supports 17 languages; ambiguous references are left out rather than guessed.
Why are some dependencies missing?
Codefield analyzes static source relationships, not runtime behavior. External packages and standard libraries do not become nodes. Dynamic references and ambiguous matches can be omitted. Dependencies and build output directories are skipped, and unreadable, oversized or unparseable files are reported.
Can Codefield handle large repositories?
There is no fixed file-count limit, but analysis, layout and rendering depend on your machine. Individual source files over 1 MiB are skipped and reported. Very large graphs take more time and memory. Opening a smaller subfolder can make exploration easier.
Impact & Path Finder
What does Impact Mode mean?
It follows incoming dependencies to find files that could be affected by changing the selected file, directly or through other files. Results are grouped by depth. This is potential structural dependency impact, not a guarantee of runtime effects.
What does Path Finder mean?
It finds the shortest directed chain of dependencies from one file to another in the static graph. A → B means A imports B. Direction matters: the reverse path may differ or not exist. If no path is found, that only means the static graph has none in that direction.
Do filters change Impact Mode or Path Finder results?
Both modes use the full graph, including files hidden by filters. Hidden files are counted and marked. Only one mode can be active at a time.
Windows & Linux
How do I install the CLI?
The official package is @keremcanozkurt/codefield and requires Node.js 20.9 or later. Install it with npm install -g @keremcanozkurt/codefield, then run codefield . in your project folder. Use codefield <folder> for another local folder or codefield clone <remote> [folder] to clone with your installed Git.
Why isn’t there a Choose Folder button in the browser?
The local server reads only the folder chosen in your terminal. Keeping folder selection outside the browser prevents a web page from asking it to read another folder. Start codefield <folder> to open a different repository.
How does codefield clone work?
Run codefield clone <remote> [folder]. Codefield uses your installed Git and existing SSH keys, agent and credential helpers. The result is an ordinary working copy in the destination you choose. Codefield does not update or delete the clone, and cloning stops if the destination already exists and is not empty.
Where does Export PNG save the image?
Your browser saves it to its configured download location. PNG export captures Graph, including active Impact Mode or Path Finder highlighting.
macOS
Is there a signed macOS release?
Not yet. Codefield for macOS is a functional unsigned preview. The current build is not Developer ID signed and notarized with Apple. Public download availability is being prepared; see Downloads for the current status. macOS may show a Gatekeeper warning when opening an unsigned build.
How do I open or revisit a repository?
Use Open Repository (⌘O), drag a folder onto the window, or choose File > Open Recent. The native app analyzes the folder locally; it needs no Node.js installation or local server. Each window holds one repository.
Which folders can the app read?
The app runs in the macOS App Sandbox. It reads the folders you open, drop onto the window, reopen from the recent list or clone. Recent folders are remembered with security-scoped bookmarks. Source code and credentials are not stored in that list.
How does Clone Git Repository work on macOS?
Choose File > Clone Git Repository, enter the remote and choose a destination. A helper runs your installed Git outside the sandbox so existing authentication works. If SSH or credentials need setup, use Terminal first. Codefield does not accept unknown host keys for you, and it never asks for passwords or tokens.
How do I refresh the view or export an image?
Use Analyze Again (⌘R) to read the current working tree. Find File (⌘F) focuses search. The first Export PNG asks you to choose an export folder; later exports save there directly. File > Choose Export Folder… changes it. The save confirmation shows the file name and offers Show in Finder. Escape leaves the workspace’s full screen, then an active exploration mode, then the selection; it does not close the window.
License & contributions
Is the source available?
Yes. Codefield is source-available under the PolyForm Noncommercial License 1.0.0. You can read, fork and modify it for personal and non-commercial use. Contributions and pull requests are welcome. Commercial use requires permission from Kerem Can Özkurt. See LICENSE in the relevant product repository for the full terms.
Still have a question?
If the FAQ didn’t fully answer it, you can reach us at [email protected].
Support continued development.
Codefield is free to use for permitted non-commercial use. If you’d like to support its continued development:
Support Codefield ↗