@voidrun/sdk 0.0.29 → 0.0.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -25
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -39,11 +39,10 @@ import { VoidRun } from "@voidrun/sdk";
|
|
|
39
39
|
// Initialize the SDK with your credentials
|
|
40
40
|
const vr = new VoidRun({
|
|
41
41
|
apiKey: "your-api-key-here",
|
|
42
|
-
baseUrl: "https://api.voidrun.com"
|
|
43
42
|
});
|
|
44
43
|
|
|
45
44
|
// Create a sandbox
|
|
46
|
-
const sandbox = await vr.createSandbox({
|
|
45
|
+
const sandbox = await vr.createSandbox({});
|
|
47
46
|
|
|
48
47
|
// Execute a command
|
|
49
48
|
const result = await sandbox.exec({ command: 'echo "Hello from VoidRun"' });
|
|
@@ -703,7 +702,6 @@ The SDK can be configured by passing options to the `VoidRun` constructor:
|
|
|
703
702
|
```typescript
|
|
704
703
|
const vr = new VoidRun({
|
|
705
704
|
apiKey: "your-api-key", // Required: Your API key
|
|
706
|
-
baseUrl: "https://api.voidrun.com", // Required: API base URL
|
|
707
705
|
orgId: "your-org-id" // Optional: Organization ID
|
|
708
706
|
});
|
|
709
707
|
```
|
|
@@ -778,8 +776,7 @@ Pass your API key in the constructor:
|
|
|
778
776
|
|
|
779
777
|
```typescript
|
|
780
778
|
const vr = new VoidRun({
|
|
781
|
-
apiKey: "your-api-key"
|
|
782
|
-
baseUrl: "https://api.voidrun.com"
|
|
779
|
+
apiKey: "your-api-key"
|
|
783
780
|
});
|
|
784
781
|
```
|
|
785
782
|
|
|
@@ -789,8 +786,7 @@ Pass the base URL in the constructor:
|
|
|
789
786
|
|
|
790
787
|
```typescript
|
|
791
788
|
const vr = new VoidRun({
|
|
792
|
-
apiKey: "your-api-key"
|
|
793
|
-
baseUrl: "https://api.voidrun.com"
|
|
789
|
+
apiKey: "your-api-key"
|
|
794
790
|
});
|
|
795
791
|
```
|
|
796
792
|
|
|
@@ -842,7 +838,6 @@ const content = await sandbox.fs.downloadFile("/app/file.txt");
|
|
|
842
838
|
Full API documentation is available at:
|
|
843
839
|
|
|
844
840
|
- [API Client Docs](./src/api-client/docs/)
|
|
845
|
-
- [OpenAPI Spec](./openapi.yml)
|
|
846
841
|
|
|
847
842
|
## Contributing
|
|
848
843
|
|
|
@@ -854,26 +849,10 @@ ISC License - See LICENSE file for details
|
|
|
854
849
|
|
|
855
850
|
## Support
|
|
856
851
|
|
|
857
|
-
- 📧 Email: support@
|
|
852
|
+
- 📧 Email: support@void-run.com
|
|
858
853
|
- 🐛 Issues: [GitHub Issues](https://github.com/voidrun/ts-sdk/issues)
|
|
859
854
|
- 💬 Discussions: [GitHub Discussions](https://github.com/voidrun/ts-sdk/discussions)
|
|
860
855
|
|
|
861
|
-
## Changelog
|
|
862
|
-
|
|
863
|
-
### v0.0.2
|
|
864
|
-
|
|
865
|
-
- Fixed PTY session response field mapping
|
|
866
|
-
- Added fallback logic for empty sessionId
|
|
867
|
-
- Improved error handling and validation
|
|
868
|
-
|
|
869
|
-
### v0.0.1
|
|
870
|
-
|
|
871
|
-
- Initial release
|
|
872
|
-
- Sandbox management
|
|
873
|
-
- File operations
|
|
874
|
-
- Code execution
|
|
875
|
-
- PTY support
|
|
876
|
-
|
|
877
856
|
---
|
|
878
857
|
|
|
879
858
|
**Made with ❤️ by VoidRun**
|