https://github.com/campvanilla/ditto

A CLI tool to convert your VSCode theme to an iTerm2 theme. 🎨
https://github.com/campvanilla/ditto

cli iterm2 iterm2-color-scheme iterm2-theme theme vscode

Last synced: 3 days ago
JSON representation

A CLI tool to convert your VSCode theme to an iTerm2 theme. 🎨

• Host: GitHub
• URL: https://github.com/campvanilla/ditto
• Owner: campvanilla
• License: gpl-3.0
• Created: 2020-11-09T07:29:16.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-11-12T06:12:47.000Z (over 3 years ago)
• Last Synced: 2026-02-05T03:04:06.485Z (5 months ago)
• Topics: cli, iterm2, iterm2-color-scheme, iterm2-theme, theme, vscode
• Language: JavaScript
• Homepage: https://github.com/campvanilla/ditto
• Size: 87.9 KB
• Stars: 128
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  



![CI](https://github.com/campvanilla/ditto/workflows/Unit%20Tests%20CI/badge.svg?branch=main&event=push) ![npm (scoped)](https://img.shields.io/npm/v/@campvanilla/ditto-cli?style=flat) ![GitHub](https://img.shields.io/github/license/campvanilla/ditto?color=yellow&style=flat) 

[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat)](#contributors-)

## ditto

> A CLI tool to convert your VSCode theme to an iTerm2 theme. 🎨

![BannerGif](https://user-images.githubusercontent.com/6417910/99155780-1662c180-26e1-11eb-92b8-7ae6c2fb22a2.gif)

## Usage

### System requirements

- NodeJS 10+. The tool does work with NodeJS 8.x, but we do not officially support it.

Tested on macOS, Linux and Windows (via [Windows Terminal](https://www.microsoft.com/en-us/p/windows-terminal/9n0dx20hk701?activetab=pivot:overviewtab))

### Running / Installation

We recommend using `npx` to run the CLI:-

```bash

npx @campvanilla/ditto-cli

```

Or, alternatively, install it globally via npm and then run:-

```bash

$ npm install -g @campvanilla/ditto-cli

$ ditto-cli

```

### Setting in iTerm2

Once an iterm color scheme file is generated, `Cmd + Click` on the _file name_ (with extension as `*.itermcolors`) in `iTerm2` to automatically import the preset into iTerm & then select the theme from preferences (`Cmd + i` → `Colors` tab → `Color Presets` → Select the generated color preset).

### Custom Options

  

    

      

        CLI Argument

      

      

        Optional

      

      

        Description

      

      

        Default Value

      

    

  

  

    

      --extensions-dir

      yes

      To specify the folder containing your VSCode extensions you've configured VSCode to save extensions in a custom directory

      

        
Mac: ~/.vscode/extensions

        
Linux: ~/.vscode/extensions

        
Windows: C:/Users/{currentUser}/.vscode/extensions

      

    

    

      --out-dir

      yes

      To specify the folder to which the iTerm2 theme file will be written

      The current working directory

    

    

      --verbose

      yes

      Execute cli with verbose output

      false

    

    

      --dry-run

      yes

      Execute script without writing final iTerm2 theme to disk

      false

    

    

      --help

      yes

      Provides documentation

      -

    

  


## Development

1. Clone the project

```

$ git clone https://github.com/campvanilla/ditto.git

```

1. Install dependencies

```

$ npm install

```

1. To test the changes to the tool, create a local build of the project

```

$ npm link

```

This should add the `ditto-cli` command to terminal.

```

$ ditto-cli

```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Aditi Mohanty
🤔 💻 🚧

    
Abinav Seelan
💻 🚧

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!