bednar/frame-it-cli repository overview

⁠FrameIt CLI Docker Image

This Docker image is designed to simplify the use of the FrameIt command in Fastlane⁠, which automates the process of adding device frames to screenshots.

⁠Prerequisites

Ensure you have Docker installed on your system to use this image. Download Docker from Docker's official site⁠.

⁠Getting the Docker Image

The Docker image is hosted on Docker Hub and can be pulled using the following command:

docker pull bednar/frame-it-cli

⁠Building the Docker Image Locally

If you prefer to build the image locally, clone this repository and navigate to the directory containing the Dockerfile. Run the following command:

docker build -t bednar/frame-it-cli .

⁠Usage

With the Docker image, you can execute various commands using Fastlane's FrameIt⁠. Here are some example commands:

⁠Adding Frames to Screenshots

To add device frames to your screenshots, use the following command:

docker run -it --rm -v $(pwd):/app bednar/frame-it-cli frameit

⁠Specifying a Custom Configuration File

If you have a custom FrameIt configuration file, you can specify it using the following command:

docker run -it --rm -v $(pwd):/app bednar/frame-it-cli frameit --config path/to/your/Framefile.json

⁠Specifying a Screenshots Directory

You can specify the directory where your screenshots are located:

docker run -it --rm -v $(pwd):/app bednar/frame-it-cli frameit --path path/to/your/screenshots

⁠Contributing

We welcome contributions from the community. Whether it's improving the Dockerfile, adding more examples, or reporting issues, your input is appreciated.

⁠License

This project is released under the MIT License. See the LICENSE⁠ file in the repository for more details.

⁠Contact

If you have any questions or need help, please open an issue in this GitHub repository for support and inquiries. Follow this link to create a new issue: Open an Issue⁠.