Skip to main content

Every project should have a good story behind it. With a good story (git history), you can reason about changes in a way that would be impossible just looking at a codebase. But let us do the work in creating that story

Project description

Codestory CLI

Tests Docs Deployment GitHub Release PyPI Version

The Codestory CLI is a high level interface over git. Why? Git is a powerful tool. It is also an excellent tool for shooting yourself in the foot.

While Git provides the infrastructure for version control, you rarely need to be down in the pipes for daily work. Codestory lets you do 99% of regular tasks much more effectively. When you need Git, its always there for those more complex tasks. It does not replace Git; it allows you to use it effectively without the headache.

Codestory provides powerful commands to enhance your version control workflow: commit changes into small, logical commits with AI-generated messages; fix past commits by intelligently splitting them into more focused changes; clean entire repository histories to improve commit quality; and configure settings to tailor the tool to your needs.

Think of this as a natural transition to a higher-level version control, where you can worry less about housekeeping and focus on building.

Quick Start

# Initialize and follow onboarding
cst

# Commit all changes into small, logical commits with AI-generated messages
cst commit

# Commit with specific instructions for the AI
cst commit -m "Split this into 2 commits: refactor then feature"

# Fix a specific past commit
cst fix <commit-sha>

# Clean entire repository history
cst clean

Documentation

For comprehensive guides, configuration priority, and supported languages, visit our documentation site:

👉 docs

The documentation site provides detailed information on:

Contributing

If you find a bug, feel free to create a pull request.

License

The code is licensed under GPLv2, just like Git.

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

codestory_cli-0.1.6.tar.gz (177.4 kB view details)

Uploaded Source

Built Distribution

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

codestory_cli-0.1.6-py3-none-any.whl (259.0 kB view details)

Uploaded Python 3

File details

Details for the file codestory_cli-0.1.6.tar.gz.

File metadata

  • Download URL: codestory_cli-0.1.6.tar.gz
  • Upload date:
  • Size: 177.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for codestory_cli-0.1.6.tar.gz
Algorithm Hash digest
SHA256 e4ad29e26e53274bf9f021e10317581a67b3a8dfb4d16b84e7bc2aecc46a9f14
MD5 fb79de7d9353ff73c2b47aef4362fe3d
BLAKE2b-256 1f722bce19910bf7b514ea971bf06e47e370f2edbaa628c4caeba30e61d39b05

See more details on using hashes here.

File details

Details for the file codestory_cli-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: codestory_cli-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 259.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for codestory_cli-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0c8f5d5d3c3bb3eedda19c996c98d05808dc8766a15128bedb3612fde717a056
MD5 c33b78435cc30e3cd038569235716361
BLAKE2b-256 e81712c1bbe4a309187ea4943db94b10e14a1852d3ac09facbc27b90c4969a4b

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