Skip to main content

My Engineer is an AI coding assistant that is good at creating or editing multiple files at a time.

Project description

My Engineer

My Engineer is an AI coding assistant that excels at editing multiple files simultaneously.

GitHub Codespaces

My Engineer works well in GitHub Codespaces. It's easy to try it out: https://github.com/codespaces

Installation (from pip)

Locally

python -m venv .venv
source .venv/bin/activate
pip install my-engineer

Globally

brew install pipx
pipx ensurepath
pipx install my-engineer

Globally (windows)

python3 -m pip install my-engineer
python3 -m my_engineer

Installation (from sources)

pip install -r my_engineer/requirements.txt
python3 -m my_engineer

Execution

# must run at the root of your application
my-engineer

How to Use

  • My Engineer will open a blank VS Code file. Enter your instructions (e.g., "Write a complete Next.js application" or "Add comments to all files in my codebase"). Processing will start when you close the file.

Things to Know

  • My Engineer uses Claude 3.5 Sonnet to generate code change instructions, but uses Claude 3 Haiku for everything else.
  • Anthropic API requests are cached, so continuing a conversation costs only 10% of starting a new one.
  • You have 5 minutes to continue a conversation before the Anthropic cache expires.
  • A log of the interaction with the LLM is created in the runs/ folder.
  • The file_summaries.yaml file is only updated with new files. If you make significant changes to many files, delete it so it gets re-created.
  • After you've completed a conversation, commit all your changes. my-engineer will offer to create a new branch for the next batch of changes.
  • Before you commit the changes from my-engineer, you can view all of them with COMMAND-SHIFT-P, then "Git: View Changes".
  • For small application, it's better to always include all files in the context.
  • Add your code files, types definition and db structures to always_include_patterns.txt so that they are always included in the context.

Recommended Additions to .gitignore

.venv
runs/
file_summaries.yaml

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

my_engineer-0.1.11.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

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

my_engineer-0.1.11-py3-none-any.whl (64.2 kB view details)

Uploaded Python 3

File details

Details for the file my_engineer-0.1.11.tar.gz.

File metadata

  • Download URL: my_engineer-0.1.11.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for my_engineer-0.1.11.tar.gz
Algorithm Hash digest
SHA256 197c240924b3c5d1c120448c6b794a6af847cbd6164baec114c7cd106012bee8
MD5 f21ecce72c1a9df9d3970145ba2de53f
BLAKE2b-256 066f8e537dd3e94cb0576453c55df8876d03468bd31a1602bedf36250ec6b7e8

See more details on using hashes here.

File details

Details for the file my_engineer-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: my_engineer-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 64.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for my_engineer-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ff0953fb7ae48b5822490407404fceb503493ea7dff91b51511f4fe56f687643
MD5 99f25044ad0e797610659de4e0bf1768
BLAKE2b-256 eaa34002af2e854f7b66da67d714a86796b90e0a63c64bfd350564eccf12bd12

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