files.md

Files

Brief description of each file in the codex-sync codebase.

Root Files

File	Description
package.json	npm package config with bin entry for CLI, dependencies, and scripts
tsconfig.json	TypeScript compiler configuration
README.md	Project documentation with setup instructions and usage
LICENSE	MIT license
changelog.md	Version history and release notes
codex-commands.md	Complete CLI commands reference with examples
.gitignore	Git ignore rules for node_modules, dist, config
.npmignore	npm publish ignore rules

Source Files (src/)

File	Description
index.ts	Main module exports for programmatic use
cli.ts	CLI entry point with all commands, reads version dynamically from package.json
client.ts	OpenSync API client with session/message transforms, cost calculation, project name extraction
config.ts	Configuration management (load, save, env vars, paths)
hook.ts	Codex CLI notify hook handler for agent-turn-complete events
parser.ts	JSONL session file parser with flexible content extraction and turn_context model extraction
toml.ts	Simple TOML parser for reading/writing Codex config.toml
types.ts	TypeScript types including RolloutItemTurnContext, SyncSessionData, SyncMessageData

Config Files (.cursor/rules/)

File	Description
dev2.mdc	Development guidelines and best practices
help.mdc	Core development guidelines
gitruels.mdc	Git safety protocol
convex2.mdc	Convex development guidelines
convex-write-conflicts.mdc	Write conflict prevention patterns
rulesforconvex.mdc	Convex function best practices
task.mdc	Task management guidelines
write.mdc	Writing style guide
sec-check.mdc	Security check rules