Skip to main content

๐Ÿฆพ ๐Ÿค– ChatGPT-based Agent tool for support your software development.

Project description

Code-Agent ๐Ÿš€

Use codex command to automate software development workflows. โœจ

TODO: Update README to v3.0.. , including code refactor agent and code audit agent Hi๐Ÿ‘‹ I'm Shingo Morimoto, an University student in Japan. And I'm so interested in creating LLM application using LangChain.

The codex command,including subcommands: gen-commit, gen-readme, describe, suggest-comment, suggest-code, is a powerful tool to integrate your code with LLM power.โœจ Currently, you can execute codex gen-commit to automate the creation of Git commit message from diff between HEAD commit and index.

๐ŸŒŸ Getting Started

Install code-agent with pip ๐Ÿ“:

To use the codex command anywhere install it with pip:

pip install code-agent or pip install --break-system-packages code-agent if you are using newer pip.

Export OPENAI_API_KEY โš™๏ธ:

You must export an OPENAI_API_KEY in your environment. Also, you must have an access to the GPT-4 model to call OpenAI API.

Usage ๐Ÿš€:

Amazing! Now you can use codex command anywhere!

$ codex --help

 Usage: codex [OPTIONS] COMMAND [ARGS]...

โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ --install-completion          Install completion for the current shell.                                                                                    โ”‚
โ”‚ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                             โ”‚
โ”‚ --help                        Show this message and exit.                                                                                                  โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
โ•ญโ”€ Commands โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ describe            [Unimplemented feature]: Describe the source code in files -> codex describe --help                                                    โ”‚
โ”‚ gen-commit          Generate a commit message from Git diff between HEAD and index.                                                                        โ”‚
โ”‚ gen-readme          [Unimplemented feature]: Generate Awesome README for your project in interactive way -> codex gen_readme --help                        โ”‚
โ”‚ say-goodbye                                                                                                                                                โ”‚
โ”‚ say-hello                                                                                                                                                  โ”‚
โ”‚ suggest-code        [Unimplemented feature]: Refactor and Suggest code for source code in specified files -> codex suggest_code --help                     โ”‚
โ”‚ suggest-comment     [Unimplemented feature]: Suggest comment for source code in specified files -> codex suggest_comment --help                            โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Generation Result Example๐Ÿคฉ:ใ€€

codex gen-commit

    ๐ŸŒŸ Implement Rust cat command with line numbering features

    Changes(4):
     ๐Ÿšฉ Added command-line parsing   @ src/lib.rs
         Integrated clap library for command-line argument parsing with custom Args struct, supporting file inputs and line numbering options.
     ๐Ÿšฉ Implemented file reading functionality   @ src/lib.rs
         Developed file opening and reading capabilities, handling both standard input and file input streams.
     ๐Ÿšฉ Implemented line numbering features   @ src/lib.rs
         Added functionality to number lines and number nonblank lines as per command-line arguments.
     ๐Ÿšฉ Added main application logic   @ src/main.rs
         Created the main function to parse arguments and execute the application logic, with error handling and process exit on failure.

Dive in! ๐ŸŒŠ

With these steps, you're all set to revolutionize your Git commits. May your coding be effortless and your repositories vibrant! ๐Ÿ’ซ

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

code_agent-0.3.0.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

code_agent-0.3.0.1-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file code_agent-0.3.0.1.tar.gz.

File metadata

  • Download URL: code_agent-0.3.0.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.1 CPython/3.12.2 Darwin/23.1.0

File hashes

Hashes for code_agent-0.3.0.1.tar.gz
Algorithm Hash digest
SHA256 9da945ea108d3bfe5b60a7ba7f8e206566a20d74447a17ca0f5f4bad24cb360e
MD5 7facb6a993e3fe224f0a8986d84708bb
BLAKE2b-256 2846fec25fbc60b5b251b53b702806977b27eeaf51b0390ff3ac99d22c498642

See more details on using hashes here.

File details

Details for the file code_agent-0.3.0.1-py3-none-any.whl.

File metadata

  • Download URL: code_agent-0.3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.1 CPython/3.12.2 Darwin/23.1.0

File hashes

Hashes for code_agent-0.3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 17f00971b4f1914ab07a161c8f7fd0856e4c5661885d42d9e747c31b735b87b1
MD5 d7b2b2cb16361e133f27a89e5f215af2
BLAKE2b-256 a98dbe4467794fd4a02fe8d76617a4832bca90df5be6075452608e29d93faa25

See more details on using hashes here.

Supported by

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