# codesnap 

**Repository Path**: SuperWindcloud/codesnap

## Basic Information

- **Project Name**: codesnap 
- **Description**: rust的生成代码快照图片的终端工具 
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-26
- **Last Updated**: 2025-02-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CODESNAP
 
CODESNAP是用于生成美丽代码快照的纯制剂工具，它直接使用图形引擎来生成快照，这意味着整个过程只是计算和渲染的问题，而无需网络或基于浏览器的渲染解决方案。



![img](demo.png) 

## ✨功能
 - **快速**：纯制剂工具，直接从图形引擎生成代码快照。
 - **CLI工具**：codesNap为您提供了一个CLI工具，可以直接从命令行生成代码快照。
 - **库**：CODESNAP还为您提供了将其集成到您自己的项目中的库。
 - **行号**：生成具有行号的代码快照，如果某人想知道代码段的位置，这确实很有帮助。
 - **水印**：水印可以帮助您的代码快照更具个性化和有趣。
 - **比例**：您可以使用特定的比例因子缩放代码快照，默认情况下，CodeSnap将生成高音大小快照，以确保快照的质量。
 - **美丽的背景**：CodeSnap为您的代码快照提供了美丽的背景，您还可以自定义具有纯色或渐变色的背景颜色。
 - **多个快照格式**：CODESNAP支持多个快照格式，您可以将快照保存为PNG，SVG甚至HTML，或者您想尝试尝试ASCII代码快照:)
 - **剪贴板**：CodeSnap可以将快照直接复制到剪贴板，或从剪贴板读取代码片段以生成快照。
 - **BreadCrumb**：CodeSnap为您提供了一个与代码路径共享代码快照的面包屑，如果其他人想知道代码片段来自何处，这真的很有帮助。
## 💻 Getting started (For Windows )
>  `scoop install -u codesnap `
### CLI
For CLI tool, you can install it for different platforms:

<details>
<summary>Arch Linux</summary>

CodeSnap is available in the [extra repository](https://archlinux.org/packages/extra/x86_64/codesnap/):

```bash
pacman -S codesnap
```

</details>

<details>
<summary>Nix/NixOS</summary>

CodeSnap is available in the [nixpkgs](https://github.com/NixOS/nixpkgs):

```bash
nix-env -i codesnap
```

</details>

<details>
<summary>Cargo</summary>

```bash
cargo install codesnap-cli
```

Or install via precompiled binary:
```bash
cargo binstall codesnap-cli
```

</details>

<details>
<summary>Homebrew</summary>

```bash
brew install mistricky/tap/CodeSnap
```

</details>

Use `codesnap` command to generate code snapshot:

```bash
# Run codesnap to generate code snapshot by providing code file
codesnap -f ./code_snippet.hs -o "./output.png"

# Run codesnap --help to see more information
codesnap -h
```
 

 

## 🌰 Examples

![hello](https://github.com/user-attachments/assets/99df51ff-0957-40bd-91d0-facbd46a0bec)



## ⚙️ Configuration
CODESNAP可以接收JSON配置作为输入，配置可用于自定义快照，例如主题，背景，水印。

如果您使用的是库，则可以将配置安装到`codesnap`构建器：

 
或者，如果您使用的是CLI工具，则CODESNAP将在`〜/.config/codesnap`下为您生成默认配置文件，您可以修改配置文件以自定义快照：
所有配置项目都可以在[config.rs]