simple-exec - GitLite

KO | EN

gitlite — search

#javascript #ai #typescript #golang #go #machine-learning #deep-learning #linux #nodejs #windows #awesome #pytorch #security #openai

simple-exec

(★ 811)

🏃 A .NET library, developed by humans, for running external commands.

파일 탐색기

최종 버전 다운로드 (.zip)

- - .editorconfig-checker.json
  - .jscpd.json
  - .markdown-lint.yml
  - .yaml-lint.yml
- - ci.yml
  - infer-sharp.yml
  - lint.yml
  - release.yml
  - spell-check.yml
- dependabot.yml
- simple-exec.png
- simple-exec.svg
- Command.cs
- ExitCodeException.cs
- ExitCodeReadException.cs
- packages.lock.json
- ProcessExtensions.cs
- ProcessStartInfo.cs
- SimpleExec.csproj
- packages.lock.json
- Program.cs
- SimpleExecTester.csproj
- - AssemblyAttributes.cs
  - Capture.cs
  - Tester.cs
- CancellingCommands.cs
- ConfiguringEnvironments.cs
- EchoingCommands.cs
- ExitCodes.cs
- hello-world.cmd
- packages.lock.json
- PublicApi.cs
- PublicApi.IsVerified.verified.txt
- ReadingCommands.cs
- RunningCommands.cs
- SimpleExecTests.csproj
- Command.cs
- packages.lock.json
- Program.cs
- Targets.csproj
.cspell.json
.editorconfig
.gitattributes
.gitignore
.markdownlint.yml
build
build.cmd
CHANGELOG.md
Directory.Build.props
Global.cs
global.json
LICENSE
README.md
SimpleExec.slnx

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/adamralph/simple-exec

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd simple-exec

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. .NET

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
.NET SDK dotnet 명령어를 쓰기 위한 SDK입니다.

cd SimpleExec

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

dotnet restore

프로젝트에 필요한 패키지를 내려받습니다.

dotnet run

프로젝트를 빌드하고 바로 실행합니다.

✅ dotnet run 실행 후 터미널에 나타나는 안내 메시지나 주소를 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SimpleExec

![SimpleExec](https://raw.githubusercontent.com/adamralph/simple-exec/092a28b5dcd011725cef7f3b207fcb9a056b651d/assets/simple-exec.svg)

_[![NuGet version](https://img.shields.io/nuget/v/SimpleExec.svg?style=flat)](https://www.nuget.org/packages/SimpleExec)_

_[![CI](https://github.com/adamralph/simple-exec/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/adamralph/simple-exec/actions/workflows/ci.yml?query=branch%3Amain)_
_[![InferSharp](https://github.com/adamralph/simple-exec/actions/workflows/infer-sharp.yml/badge.svg?branch=main)](https://github.com/adamralph/simple-exec/actions/workflows/infer-sharp.yml?query=branch%3Amain)_
_[![Lint](https://github.com/adamralph/simple-exec/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/adamralph/simple-exec/actions/workflows/lint.yml?query=branch%3Amain)_
_[![Spell check](https://github.com/adamralph/simple-exec/actions/workflows/spell-check.yml/badge.svg?branch=main)](https://github.com/adamralph/simple-exec/actions/workflows/spell-check.yml?query=branch%3Amain)_

SimpleExec is a [.NET library](https://www.nuget.org/packages/SimpleExec), developed by humans, for running external commands. It wraps [`System.Diagnostics.Process`](https://apisof.net/catalog/System.Diagnostics.Process) to make things easier.

SimpleExec intentionally does not invoke the system shell.

Platform support: [.NET 8.0 and later](https://dot.net).

- [Quick start](#quick-start)
- [Run](#run)
- [Read](#read)
- [Other optional arguments](#other-optional-arguments)
- [Exceptions](#exceptions)

## Quick start

```c#
using static SimpleExec.Command;

Run("foo", "arg1 arg2");
```

## Run

```c#
Run("foo");
Run("foo", "arg1 arg2");
Run("foo", new[] { "arg1", "arg2" });

await RunAsync("foo");
await RunAsync("foo", "arg1 arg2");
await RunAsync("foo", new[] { "arg1", "arg2" });
```

By default, the command is echoed to standard output (stdout) for visibility.

## Read

```c#
var (standardOutput1, standardError1) = await ReadAsync("foo");
var (standardOutput2, standardError2) = await ReadAsync("foo", "arg1 arg2");
var (standardOutput3, standardError3) = await ReadAsync("foo", new[] { "arg1", "arg2" });
```

## Other optional arguments

### `Run`/`RunAsync`

```c#
string workingDirectory = "",
Action<IDictionary<string, string?>>? configureEnvironment = null,
IEnumerable<string> secrets = null,
Func<int, bool>? handleExitCode = null,
string? echoPrefix = null,
bool noEcho = false,
bool cancellationIgnoresProcessTree = false,
bool createNoWindow = false,
CancellationToken ct = default,
```

### `ReadAsync`

```c#
string workingDirectory = "",
Action<IDictionary<string, string?>>? configureEnvironment = null,
Func<int, bool>? handleExitCode = null,
Encoding? encoding = null,
string? standardInput = null,
bool cancellationIgnoresProcessTree = false,
CancellationToken ct = default,
```

## Exceptions

If the command has a non-zero exit code, an `ExitCodeException` is thrown with an `int` `ExitCode` property and a message in the form of:

```c#
$"The command exited with code {ExitCode}."
```

In the case of `ReadAsync`, an `ExitCodeReadException` is thrown, which inherits from `ExitCodeException`, and has `string` `StandardOutput` and `StandardError` properties, representing standard output (stdout) and standard error (stderr), and a message in the form of:

```c#
$@"The command exited with code {ExitCode}.

Standard output:

{StandardOutput}

Standard error:

{StandardError}"
```

### Overriding default exit code handling

Most programs return a zero exit code when they succeed and a non-zero exit code fail. However, there are some programs which return a non-zero exit code when they succeed. For example, [Robocopy](https://ss64.com/nt/robocopy.html) returns an exit code less than 8 when it succeeds and 8 or greater when a failure occurs.

The throwing of exceptions for specific non-zero exit codes may be suppressed by passing a delegate to `handleExitCode` which returns `true` when it has handled the exit code and default exit code handling should be suppressed, and returns `false` otherwise.

For example, when running Robocopy, exception throwing should be suppressed for an exit code less than 8:

```c#
Run("ROBOCOPY", "from to", handleExitCode: code => code < 8);
```

Note that it may be useful to record the exit code. For example:

```c#
var exitCode = 0;
Run("ROBOCOPY", "from to", handleExitCode: code => (exitCode = code) < 8);

// see https://ss64.com/nt/robocopy-exit.html
var oneOrMoreFilesCopied = exitCode & 1;
var extraFilesOrDirectoriesDetected = exitCode & 2;
var misMatchedFilesOrDirectoriesDetected = exitCode & 4;
```

---

<sub>[Run](https://thenounproject.com/term/target/975371) by [Gregor Cresnar](https://thenounproject.com/grega.cresnar/) from [the Noun Project](https://thenounproject.com/).</sub>