1.2.0 • Published 7 months ago
ssh.surf v1.2.0
npx ssh.surf
CLI is not finished yet. You can use the API Wrapper for now.
npm install ssh.surf
Import the SshSurfApi
class from the package. Then create a new instance of the class with the required parameters. Required Parameters:
apiKey
- Your SSH.SURF API Key (Required)figletDecoration
- Whether To Show The Figlet Decoration Or Not (Optional)- Vlaues:
true
orfalse
- Default Value:
true
- Vlaues:
import SshSurfApi from 'ssh.surf';
const sshsurf = new SshSurfApi({
apiKey: 'YOUR_SSH.SURF_API_KEY_HERE',
figletDecoration: true
});
hello()
- This API Method allows you to test and ensure the correct user is in use.
let response = await sshsurf.hello();
console.log(response);
name()
- This API Method allows you get the username without the hello message.
let response = await sshsurf.name();
console.log(response);
start()
- This API Method allows you to start your container.
let response = await sshsurf.start();
console.log(response);
stop()
- This API Method allows you to stop your container.
let response = await sshsurf.stop();
console.log(response);
restart()
- This API Method allows you to restart your container.
let response = await sshsurf.restart();
console.log(response);
info()
- This API method will allow you to get information about your container.
let response = await sshsurf.info();
console.log(response);
stats()
- This API method will allow you to get resource usage stats about your container.
let response = await sshsurf.stats();
console.log(response);
time()
- This API method will allow you to get information about the expire time of your container.
let response = await sshsurf.time();
console.log(response);
newRootPass()
- This API method will change the root password of your container to a random generated password.
let response = await sshsurf.newRootPass();
console.log(response);
newKey()
- This API method will generate a new API key for your account.
let response = await sshsurf.newKey();
console.log(response);
keyTime()
- This API method will check the time left until the key expires.
let response = await sshsurf.keyTime();
console.log(response);
license()
- This API method will allow you to get information about your license key purchased at our store.
let response = await sshsurf.license();
console.log(response);
exec()
- This API Method allows you to run commands your container where you can specify the working directory used. Required Parameters:cmd
- Name Of The Command.pwd
- Working Directory.
let response = await sshsurf.exec({
cmd: 'ANY_LINUX_COMMAND_HERE',
pwd: 'ANY_WORKING_DIRECTORY_HERE'
});
console.log(response);
notify()
- This API Method allows you to send notifications to your DiscordID as a DirectMessage. Required Parameters:message
- The Message You Want To Send.
let response = await sshsurf.notify({
message: 'ANY_MESSAGE_HERE'
});
console.log(response);
notifyRevolt()
- This API Method allows you to send notifications to your RevoltID as a DirectMessage. Required Parameters:message
- The Message You Want To Send.
let response = await sshsurf.notifyRevolt({
message: 'ANY_MESSAGE_HERE'
});
console.log(response);
More Comming Soon..
License: MIT