# About Inkporter

![](https://2495109519-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MA-cMcVTk3kCosU_FKo%2F-MFZq2d9f4tiDJFjp3ft%2F-MFZsZD3fYagkwA8TOLa%2Finkporter.svg?alt=media\&token=5a18c6d2-855a-4034-b889-58a7cda0dd0d)

**Inkporter** is a powerful tool to help your productivity with Inkscape. This tool is available as a Command Line Interface and Inkscape Extension, so you can choose the best option for you.

**How It Works**

Inkporter reads ID patterns (i.e icon-1, icon-2, icon-3, etc) that you've set and then exports them to the file format that you need. Inkporter allows you to feel like you are working with artboards or multiple pages in Inkscape.

**Inkporter Features**

* Artboard-like export
* Multiple PDF Page Export (Booklet)
* JPG and PDF with CMYK export
* And various export formats for productivity (PNG, JPG, SVG, EPS, PDF, and WEBP)


# Inkporter CLI (Linux)

There are two ways to install Inkporter CLI on Linux. You can use PPA or download the script directly. You can also use Inkporter CLI for Linux on Windows 10.

### Using PPA

For Debian\Ubuntu based distributions, you can use the GimpScape PPA to install Inkporter

Open your Terminal and run the commands below in the following order.

```bash
curl -s --compressed "https://gimpscape.github.io/gimpscape-ppa/tools/KEY.gpg" | sudo apt-key add -
​
sudo curl -s --compressed -o /etc/apt/sources.list.d/gimpscape-ppa.list "https://gimpscape.github.io/gimpscape-ppa/tools/gimpscape-ppa.list"
​
sudo apt update && sudo apt install inkporter
```

### Download the script directly

For other Linux distributions that don't support PPA, you can get the Inkporter script via this page: <https://github.com/raniaamina/inkporter/releases/tag/v2.3.1-linux>.  Extract the zip file and put the whole file into `/usr/local/bin/` and make sure you have set execute permissions on the file to allow it to execute as a program (`sudo chmod +x FILENAME`).

### Using Inkporter CLI for Linux on Windows 10

If you want to use the bash version of Inkporter on Windows 10, first you will need to configure the Windows Subsystem for Linux or WSL for short. To do that go to`Control Panel -> Programs -> Turn Windows features on or off` then check on `Windows Subsystem for Linux`&#x20;

![Activate Windows Subsystem for Linux](https://2495109519-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MA-cMcVTk3kCosU_FKo%2F-MCuK1ycvVOkZeZhhwex%2F-MCuVWkxdQCRpWPOqz8-%2Fimage.png?alt=media\&token=c70c98d1-53d1-4c32-8ea3-8d63cb5d9003)

Then restart your Windows and install a Linux distribution for your WSL. You can get it from the Microsoft Store or download it from [here](https://docs.microsoft.com/en-us/windows/wsl/install-manual#downloading-distros). Follow the installation instructions above depending on the distro you choose.


# Inkporter CLI (Windows)

There are two ways to install Inkporter CLI on Windows. You can use the Installer or install it manually.

### Using the Installer

![Inkporter Installer](https://2495109519-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MA-cMcVTk3kCosU_FKo%2F-MHL7YkzYWia-h3ZHZLE%2F-MHLAVLXHnzQioYg8xAk%2Fimage.png?alt=media\&token=fb6393e4-a35d-4912-8391-3682ff5de1ea)

This is the easiest way to install Inkporter on Windows. Just make sure you put your Inkscape in Program Files. Otherwise you will have to configure your Environment Variable (I'll explain how to do this in manual installation).

### Manual Installation

Manual installation means you only download the batch script and configure everything by yourself. The advantages of using this method are that you can use different versions of the dependencies as if you're using a portable version of Inkscape. A new version of the dependencies has been released. Or you can install the CLI version.

1. Clone the batch script from [here for Inkscape 1.0](https://raw.githubusercontent.com/raniaamina/inkporter/windows/1.0/inkporter_data/inkporter.bat) and [here for Inkscape 0.92.x](https://raw.githubusercontent.com/raniaamina/inkporter/windows/0.92.x/inkporter_data/inkporter.bat).
2. Put it anywhere you want, but a good place to put it is in the Inkscape directory.
3. Go to `Control Panel -> System and Security -> System -> Advanced system settings -> Environment Variables...` &#x20;
4. Double click on the "Path" variable, then add your directory to`inkporter.bat` and the dependencies directory
5. Try to run Inkporter from cmd

The advantage of using a manual installation is that you can use different builds of Inkscape or use it when you have not put your Inkscape in Program Files.


# Inkscape Extension

Inkporter is now available as an Inkscape extension. You can find it on the Inkscape [Extension Gallery Page](https://inkscape.org/~raniaamina/%E2%98%85inkporter). To use this extension, you should make sure all dependencies are installed first. Here is a complete guide to installing this extension.

### For Linux

If you are already using the [Gimpscape PPA](/how-to-install/cli-linux#using-ppa), it will also install the Inkporter extension in your Inkscape program automatically. If you want to install it manually, please copy Inkporter to the Inkscape extension directory.

Just copy and paste inkporter.inx, inkporter.py, and inkporter directory to the Inkscape extension directory, usually in `$HOME/.config/inkscape/extensions` for Linux.

To make Inkporter run correctly, please make sure that these dependencies are already installed on your system:

* Inkscape
* Ghostscript
* ImageMagick
* webp / libwebp
* zenity (for Linux & MacOS)

### For Windows

Copy inkporter.inx, inkporter.py, inkporter.bat and inkporter directory to the Inkscape Extensions directory. By default it's in `%APPDATA%\Inkscape\extensions` for Windows.

For Inkporter to run correctly, make sure that the following dependencies are already installed on your system and that you have added them to the PATH environment variables:

* Inkscape
* Ghostscript 32bit
* ImageMagick
* webp / libwebp
* 7-Zip

#### Unable to find  `extensions` directory for your Inkscape installation?

You can find it here: `Edit > Preferences > System` menu. Then look at the `User extensions` path in the `System Info` section.

### For MacOS

You need to do perform a little trick to make Inkporter work on MacOS. After you put all the extension files into the extension directory, run Inkscape with following instructions:

```
# using Inkporter in Inkscape MacOS
➜  ~ cd /Applications/Inkscape.app/Contents/MacOS
➜  MacOS ./inkscape
```


# Inkporter CLI (Linux)

##


# Inkscape CLI (Windows)

How to use it

### Calling the Inkporter

![Access Inkporter CLI from Right Click](https://2495109519-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MA-cMcVTk3kCosU_FKo%2F-MHL7YkzYWia-h3ZHZLE%2F-MHL8Lz-RNWVPxiYACzE%2Fimage.png?alt=media\&token=3f445f90-9a1b-48f7-b496-4159649d4ad7)

### From Right Click&#x20;

Inkporter can be called by right-clicking on the SVG file. You will prompted to input the object ID pattern and choose the output folder and so on.

This feature us only available on installation with the installer.

#### From CMD

![Accessing Inkporter from CMD](https://2495109519-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MA-cMcVTk3kCosU_FKo%2F-MHL7YkzYWia-h3ZHZLE%2F-MHL8xi1jx9ZUbbSUo8R%2Fimage.png?alt=media\&token=b2abd6f9-7b46-4c71-a2ca-0309ea91c064)

Inkporter can be called from cmd. To access it from any directory, you have to add the inkporter.bat directory to the PATH environment variables.

Here's how you use the extension.

`inkporter [SVG_FILE]`

Then you will be prompted to fill in the input and output folders, choose the DPI value, and so on.

#### From the Extension

The Inkporter CLI will be called by the extension to process the file. You'll have to wait a bit and it will do the job.


# Inkporter Extension

![Inkporter GUI Interface on Windows](https://2495109519-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MA-cMcVTk3kCosU_FKo%2F-MHLAfXSgfYLcU9dj00f%2F-MHLLpFye3XhkNbYzYd5%2Fimage.png?alt=media\&token=52ccadb6-408a-4ad0-9305-e83d3b5177b8)


# Contribute to Inkporter

This project is fully supported by Gimpscape Indonesia (The Biggest Indonesia F/LOSS Design Community) and has been developed by the following individuals:&#x20;

* [Sofyan Sugianto - sofyan@artemtech.id](mailto://sofyan@artemtech.id) (Programmer)
* [Rania Amina - me@raniaamina.id](https://raniaamina.id) (UI Designer)
* MasLanang - <https://github.com/maslanangdev> (Windows Dev)

You also can contribute to this project via the GitHub repository: [https://github.com/raniaamina/inkporter](https://github.com/raniaamina/inkporter/tree/inkporter-gui)

### Disclaimer & Donations

We don't guarantee anything about this tool/extension, so please use it at your own risk. We can't give 24/7 support if you have a problem when using Inkporter. Of course we'll help as much as we can. The [Gimpscape Telegram group](https://t.me/gimpscape) is the best place to ask your questions about this extension.

If you feel that this extension has helped you to create, feel free to donate a cup of coffee on the [**Dev-Lovers Page**](https://devlovers.netlify.com) :")


# Frequently Asked Questions

Some Frequently Asked Questions about Inkporter on Windows. And some things that you may not have asked yet, but probably want to know.

## What is Inkporter?

Please read the description of it [here](/).

**`#general`**

## So this is an extension that allows me to batch export to several formats?

Exactly! With this extension, you can export your Inkscape work into JPG (RGB/CMYK), PDF (RGB/CMYK), EPS, SVG Optimized, PNG, Multiple Page PDF/Booklet (RGB/CMYK).

**`#general`**&#x20;

## I got this message *'inkscape' is not recognized as an internal or external command, operable program or batch file and sometimes it says ghostscript or something else*.

Make sure you have add Inkscape and the other dependencies in the installation folder to the "Path" Environment Variable. Simply go to Control Panel -> System and Security -> System -> Advanced System Settings -> Environment Variables, then double click on the "Path" System Variable and add the directories.&#x20;

If you are using Windows 8.1 and below, separate each directory with a semicolon (;) like this: \`C:\Windows;C:\Users\username\libwebp\bin\` If you're still confused, there are plenty of tutorials on the Internet that will show you how to do this.

**`#windows`**

## I didn't get an error message, but it didn't export anything.

You likely did not input the right ID Pattern or Object ID. Inkporter exports an object or several objects depending on a unique ID and exports multiple objects from its ID Pattern.

**`#general`** **`#windows`** **`#Linux`**&#x20;

## I got an error similar to this picture

![](https://telegra.ph/file/859e670fbd7c614c3de66.png)

You didn't input the ID Pattern yet.

## How can I set the ID for my Objects Group and export it with Inkporter?

Open Object Properties on Inkscape -> select your objects group -> give them a kind of prefix like "obj". So if you have five groups of objects to export, give each group an ID with the same prefix like obj-text, obj-object, obj-object1, obj-icon, obj-init then fill out the ID Pattern on Inkporter with obj. Apply and obj-text, obj-object, obj-object1, obj-icon, obj-init will be exported into the selected directory.

**`#windows`**&#x20;

## Can I export a single object with it ?

Sure, just specify the Object ID in Inkporter and it will only export that object.&#x20;

**`#general`** **`#windows`** **`#Linux`**&#x20;

## I found a bug, how I can report it?

Please report any bugs you find in Inkporter to the Github repository here, and provide us details of errors, how to trigger it, the version of Inkscape you're using, the version of Inkporter you're using, the error message, and maybe some additional details about the bug.

**`#general`**

## I have another error that wasn't mentioned above.

You can discuss it on the GimpScape ID Telegram Group or if you're a Windows user, you can reach me here.  If you're are Linux user, check out the other pages about the Linux version or discuss it on the [**GimpScape ID**](https://t.me/gimpscape) Telegram Group).

**`#general`**

####


# Inkporter Explanation - ID

Inkporter CLI Explanation by Rania Amina

{% embed url="<https://www.youtube.com/watch?v=WDWJAbvBuuU>" %}


# Multiple Artboards with Inkporter (Linux) - ID

Export Multiple Objects / Multiple Artboards with Inkporter on Linux

{% embed url="<https://www.youtube.com/watch?v=_6FPhzD2fMY>" %}


# Mutiple Artboards with Inkporter (Windows) - ID

Export Multiple Objects / Multiple Artboards with Inkporter on Windows

{% embed url="<https://www.youtube.com/watch?v=jQJLsE2e4xg>" %}


# Inkporter Extension for Inkscape Linux - ID

How to use the Inkporter extension for Inkscape

{% embed url="<https://www.youtube.com/watch?v=-3dUiNS6gKU>" %}


# Export Multipage Document from Inkscape Directly

Export a Multiple-page PDF document in Inkscape with Inkporter

{% embed url="<https://www.youtube.com/watch?v=hTiLaBefXlY>" %}


# EXPORTAR EM CMYK NO INKSCAPE? conheça a extensão chamada INKPORTER - BR

{% embed url="<https://youtu.be/2M3T8nhIbxw>" %}


# inkporter inkscape تصميم كتاب متعدد الصفحات - AR

{% embed url="<https://youtu.be/H0iJUNJ2-sw>" %}


