@uday-rana/codeshift
v3.0.0
Published
Transform code from one language to another
Downloads
234
Readme
codeshift
Codeshift is a command-line tool to translate and transform source code files between programming languages.
Features
- Select output language to convert source code into
- Support for multiple input files
- Output results to a file or stream directly to
stdout
- Customize model and provider selection for optimal performance
- Supports leading AI providers:
Requirements
- Node.js (Requires Node.js 20.17.0+)
- An API key from any of the following providers:
- OpenAI
- OpenRouter
- Groq
- any other AI provider compatible with OpenAI's chat completions API endpoint
Installation
Run
npm install -g @uday-rana/codeshift
.Run
npx codeshift
. This will generate a.codeshift.config.toml
file in your current directory.In
.codeshift.config.toml
, set the base URL for your preferred provider and add your API key. It should look something like this:# .codeshift.config.toml [settings] baseUrl="https://openrouter.ai/api/v1" apiKey="sk-or-v1-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" outputFile="xxxxxxxxxxx" model="" tokenUsage=true stream=true
- The following base URLs are supported. Others may be used but are not supported and may cause errors:
- OpenAI:
https://api.openai.com/v1
- OpenRouter:
https://openrouter.ai/api/v1
- Groq:
https://api.groq.com/openai/v1
.
- OpenAI:
- For a list of models for supported providers, see:
- The following base URLs are supported. Others may be used but are not supported and may cause errors:
Usage
npx codeshift [options] <output-language> <input-files...>
Arguments
<output-language>
: The desired language to convert source files to<input-files...>
: Paths to the source files, separated by spaces
Options
-o, --output-file
: Specify filename to write output to-t, --token-usage
: Display the number of tokens used by the AI for processing-s, --stream
: Stream the response from the LLM.-h, --help
: Display the help message explaining usage, options, and arguments-v, --version
: Display the program name and version number
Example
# Converts a JavaScript file (index.js) to Go, saving the output in index.go
npx codeshift -o index.go go examples/index.js
Contributing
See CONTRIBUTING.md
License
This project is licensed under the MIT License. See the LICENSE file for more details.