Skip to main content

A CLI tool for managing shared context files across projects

Project description

Context File Manager (CFM)

A command-line tool for managing shared context files across projects. CFM provides a centralized repository for storing, organizing, and retrieving commonly used files with descriptions and tags.

Features

  • Centralized Storage: Store commonly used files in a single repository (~/.context-files by default)
  • File Organization: Add descriptions and tags to files for easy searching and filtering
  • Quick Retrieval: Copy files from the repository to any project location
  • Search Capabilities: Find files by name, description, or tags
  • Multiple Output Formats: View file listings in table, JSON, or simple format

Installation

From PyPI (Recommended)

pip install context-file-manager

From Source

Clone the repository and install in development mode:

git clone https://github.com/yourusername/context-file-manager.git
cd context-file-manager
pip install -e .

Manual Installation

Make the script executable and add it to your PATH:

chmod +x cfm
sudo cp cfm /usr/local/bin/

Or create an alias in your shell configuration:

alias cfm='python3 /path/to/context-file-manager/cfm'

Usage

Add a file to the repository

# Add with description
cfm add README.md "Main project documentation"

# Add with description and tags
cfm add config.json "Database configuration" --tags database config production

List files

# List all files
cfm list

# Filter by tag
cfm list --tag database

# Output as JSON
cfm list --format json

Search for files

# Search by filename, description, or tags
cfm search "config"
cfm search "database"

Retrieve a file

# Copy to current directory
cfm get README.md

# Copy to specific location
cfm get config.json ./my-project/

Update file metadata

# Update description
cfm update config.json "Production database configuration"

# Add tags to existing file
cfm tag config.json staging development

Remove a file

cfm remove old-config.json

Custom Repository Location

By default, files are stored in ~/.context-files. You can use a different location:

cfm --repo /path/to/my/repo add file.txt "Description"

File Storage

Files are stored with their original names in the repository directory. If a filename already exists, a numbered suffix is added (e.g., config_1.json, config_2.json).

Metadata is stored in spec.json within the repository, containing:

  • File descriptions
  • Original file paths
  • Tags
  • File sizes
  • Date added

Examples

Managing Configuration Files

# Store various config files
cfm add nginx.conf "Nginx configuration for load balancing" --tags nginx webserver
cfm add docker-compose.yml "Standard Docker setup" --tags docker devops
cfm add .eslintrc.js "JavaScript linting rules" --tags javascript linting

# Find all Docker-related files
cfm list --tag docker

# Get a config for a new project
cfm get docker-compose.yml ./new-project/

Managing Documentation Templates

# Store documentation templates
cfm add README-template.md "Standard README template" --tags documentation template
cfm add API-docs-template.md "API documentation template" --tags documentation api

# Search for documentation
cfm search "template"

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

context_file_manager-0.1.0.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

context_file_manager-0.1.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file context_file_manager-0.1.0.tar.gz.

File metadata

  • Download URL: context_file_manager-0.1.0.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for context_file_manager-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c50888e03f15d9e5874c37992ed1acc85ad025ac608924469c7a86ebb056b061
MD5 1d7571a7c787afad29d3e2b957e0af5f
BLAKE2b-256 8790e17e62ac2d09c51556e0e3d9dc339049ce3140dede0cfef0978a32bcb773

See more details on using hashes here.

File details

Details for the file context_file_manager-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for context_file_manager-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a25c86fd98e444e49e078a5db5091fdcedb4e3b4b9dde4c78c9848e5f9b035de
MD5 8c460dd0de14adaa2dea7c6fa6822307
BLAKE2b-256 9bfed92cb156dbab400f2bd4f9dbab030422225747f2e1bf6d2a0dc79273e066

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page